AccountEventTemplate

@objc(UAAccountEventTemplate)
public class AccountEventTemplate : NSObject

AccountEventTemplate represents a custom account event template for the application.

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

    Declaration

    Swift

    @objc
public var eventValue: NSNumber?

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

    Declaration

    Swift

    @objc
public var transactionID: String?

  • The event’s identifier.

    Declaration

    Swift

    @objc
public var userID: String?

  • The event’s category.

    Declaration

    Swift

    @objc
public var category: String?

  • The event’s type.

    Declaration

    Swift

    @objc
public var type: String?

  • Factory method for creating a registered account event template.

    Declaration

    Swift

    @objc
public class func registeredTemplate() -> AccountEventTemplate

    Return Value

    An Account event template instance

  • Factory method for creating a registered account event template with a value from a string.

    Declaration

    Swift

    @objc(registeredTemplateWithValueFromString:)
public class func registeredTemplate(valueString: String?)
    -> AccountEventTemplate

    Parameters

    valueString

    The value of the event as a string. The value must be a valid number between -2^31 and 2^31 - 1 or it will invalidate the event.

    Return Value

    An Account event template instance

  • Factory method for creating a registered account event template with a value.

    Declaration

    Swift

    @objc(registeredTemplateWithValue:)
public class func registeredTemplate(value: NSNumber?)
    -> AccountEventTemplate

    Parameters

    value

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

    Return Value

    An Account event template instance

  • Factory method for creating a logged in account event template.

    Declaration

    Swift

    @objc
public class func loggedInTemplate() -> AccountEventTemplate

    Return Value

    An Account event template instance

  • Factory method for creating a logged in account event template with a value from a string.

    Declaration

    Swift

    @objc(loggedInTemplateWithValueFromString:)
public class func loggedInTemplate(valueString: String?)
    -> AccountEventTemplate

    Parameters

    valueString

    The value of the event as a string. The value must be a valid number between -2^31 and 2^31 - 1 or it will invalidate the event.

    Return Value

    An Account event template instance

  • Factory method for creating a logged in account event template with a value.

    Declaration

    Swift

    @objc(loggedInTemplateWithValue:)
public class func loggedInTemplate(value: NSNumber?) -> AccountEventTemplate

    Parameters

    value

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

    Return Value

    An Account event template instance

  • Factory method for creating a logged out account event template.

    Declaration

    Swift

    @objc
public class func loggedOutTemplate() -> AccountEventTemplate

    Return Value

    An Account event template instance

  • Factory method for creating a logged out account event template with a value from a string.

    Declaration

    Swift

    @objc(loggedOutTemplateWithValueFromString:)
public class func loggedOutTemplate(valueString: String?)
    -> AccountEventTemplate

    Parameters

    valueString

    The value of the event as a string. The value must be a valid number between -2^31 and 2^31 - 1 or it will invalidate the event.

    Return Value

    An Account event template instance

  • Factory method for creating a logged out account event template with a value.

    Declaration

    Swift

    @objc(loggedOutTemplateWithValue:)
public class func loggedOutTemplate(value: NSNumber?)
    -> AccountEventTemplate

    Parameters

    value

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

    Return Value

    An Account event template instance

  • Creates the custom account event.

    Declaration

    Swift

    @objc
public func createEvent() -> CustomEvent?