CustomEvent Structure Reference


                    
                    
                    maxPropertiesSize

Max properties size in bytes

Declaration

Swift

public static let maxPropertiesSize: Int


                    
                    
                    defaultEncoder()

Default encoder. Uses iso8601 date encoding strategy.

Declaration

Swift

public static func defaultEncoder() -> JSONEncoder


                    
                    
                    eventValue

The event’s value. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event.

Declaration

Swift

public var eventValue: Decimal


                    
                    
                    eventName

The event’s name. The name’s length must not exceed 255 characters or it will or it will invalidate the event.

Declaration

Swift

public var eventName: String


                    
                    
                    transactionID

The event’s transaction ID. The ID’s length must not exceed 255 characters or it will invalidate the event.

Declaration

Swift

public var transactionID: String?


                    
                    
                    interactionType

The event’s interaction type. The type’s length must not exceed 255 characters or it will invalidate the event.

Declaration

Swift

public var interactionType: String?


                    
                    
                    interactionID

The event’s interaction ID. The ID’s length must not exceed 255 characters or it will invalidate the event.

Declaration

Swift

public var interactionID: String?


                    
                    
                    properties

The event’s properties.

Declaration

Swift

public private(set) var properties: [String : AirshipJSON] { get }


                    
                    
                    setProperty(string:forKey:)

Sets a property string value.

Declaration

Swift

public mutating func setProperty(
    string: String,
    forKey key: String
)

Parameters

`string`	The string value to set.
`forKey`	The properties key


                    
                    
                    removeProperty(forKey:)

Removes a property.

Declaration

Swift

public mutating func removeProperty(
    forKey key: String
)

Parameters


                                forKey

The properties key


                    
                    
                    setProperty(double:forKey:)

Sets a property double value.

Declaration

Swift

public mutating func setProperty(
    double: Double,
    forKey key: String
)

Parameters

`double`	The double value to set.
`forKey`	The properties key


                    
                    
                    setProperty(bool:forKey:)

Sets a property bool value.

Declaration

Swift

public mutating func setProperty(
    bool: Bool,
    forKey key: String
)

Parameters

`bool`	The bool value to set.
`forKey`	The properties key


                    
                    
                    setProperty(value:forKey:encoder:)

Sets a property value.

Declaration

Swift

public mutating func setProperty(
    value: Any,
    forKey key: String,
    encoder: @autoclosure () -> JSONEncoder = Self.defaultEncoder()
) throws

Parameters

`value`	The value to set.
`forKey`	The properties key
`encoder`	JSONEncoder to use.‘


                    
                    
                    setProperties(_:encoder:)

Sets a property value.

Declaration

Swift

public mutating func setProperties(
    _ object: Any,
    encoder: @autoclosure () -> JSONEncoder = Self.defaultEncoder()
) throws

Parameters

`value`	The values to set. The value must result in a JSON object or an error will be thrown.
`encoder`	JSONEncoder to use.


                    
                    
                    init(name:value:)

Default constructor.

Declaration

Swift

public init(name: String, value: Double = 1.0)

Parameters

`name`	The name of the event. The event’s name must not exceed 255 characters or it will invalidate the event.
`value`	The event value. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event. Defaults to 1.


                    
                    
                    init(name:decimalValue:)

Default constructor.

Declaration

Swift

public init(name: String, decimalValue: Decimal)

Parameters

`name`	The name of the event. The event’s name must not exceed 255 characters or it will invalidate the event.
`value`	The event value. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event. Defaults to 1.


                    
                    
                    AccountTemplate

Account template

Declaration

Swift

enum AccountTemplate : Sendable


                    
                    
                    AccountProperties

Additional acount template properties

Declaration

Swift

struct AccountProperties : Encodable, Sendable


                    
                    
                    init(accountTemplate:properties:encoder:)

Constructs a custom event using the account template.

Declaration

Swift

init(
    accountTemplate: AccountTemplate,
    properties: AccountProperties = AccountProperties(),
    encoder: @autoclosure () -> JSONEncoder = CustomEvent.defaultEncoder()
)

Parameters

`accountTemplate`	The account template.
`properties`	Optional additional properties
`encoder`	Encoder used to encode the additional properties. Defaults to `CustomEvent.defaultEncoder`.


                    
                    
                    track()

Adds the event to analytics. A wrapper arou

Declaration

Swift

public func track()


                    
                    
                    MediaTemplate

Media event types

Declaration

Swift

enum MediaTemplate : Sendable


                    
                    
                    MediaProperties

Additional media template properties

Declaration

Swift

struct MediaProperties : Encodable, Sendable


                    
                    
                    init(mediaTemplate:properties:encoder:)

Constructs a custom event using the media template.

Declaration

Swift

init(
    mediaTemplate: MediaTemplate,
    properties: MediaProperties = MediaProperties(),
    encoder: @autoclosure () -> JSONEncoder = CustomEvent.defaultEncoder()
)

Parameters

`mediaTemplate`	The media template.
`properties`	Media properties.
`encoder`	Encoder used to encode the additional properties. Defaults to `CustomEvent.defaultEncoder`.


                    
                    
                    RetailTemplate

Retail templates

Declaration

Swift

enum RetailTemplate : Sendable


                    
                    
                    RetailProperties

Additional retail template properties

Declaration

Swift

struct RetailProperties : Encodable, Sendable


                    
                    
                    init(retailTemplate:properties:encoder:)

Constructs a custom event using the retail template.

Declaration

Swift

init(
    retailTemplate: RetailTemplate,
    properties: RetailProperties = RetailProperties(),
    encoder: @autoclosure () -> JSONEncoder = CustomEvent.defaultEncoder()
)

Parameters

`accountTemplate`	The retail template.
`properties`	Optional additional properties
`encoder`	Encoder used to encode the additional properties. Defaults to `CustomEvent.defaultEncoder`.


                    
                    
                    SearchTemplate

Search template

Declaration

Swift

enum SearchTemplate : Sendable


                    
                    
                    SearchProperties

Additional search template properties

Declaration

Swift

struct SearchProperties : Encodable, Sendable


                    
                    
                    init(searchTemplate:properties:encoder:)

Constructs a custom event using the search template.

Declaration

Swift

init(
    searchTemplate: SearchTemplate,
    properties: SearchProperties = SearchProperties(),
    encoder: @autoclosure () -> JSONEncoder = CustomEvent.defaultEncoder()
)

Parameters

`accountTemplate`	The search template.
`properties`	Optional additional properties
`encoder`	Encoder used to encode the additional properties. Defaults to `CustomEvent.defaultEncoder`.