UAAccountEventTemplate

Objective-C

@interface UAAccountEventTemplate : NSObject

Swift

class UAAccountEventTemplate : NSObject

A UAAccountEventTemplate represents a custom account event template for the application.

Account Event Template Properties

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

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDecimalNumber *eventValue;

    Swift

    var eventValue: NSDecimalNumber? { get set }
  • The event’s transaction ID. The transaction ID’s length must not exceed 255 characters or it will invalidate the event.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *transactionID;

    Swift

    var transactionID: String? { get set }
  • The event’s category.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *category;

    Swift

    var category: String? { get set }
  • The event’s user ID.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *userID;

    Swift

    var userID: String? { get set }
  • The event’s type.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *type;

    Swift

    var type: String? { get set }

Account Event Template Factories

  • Factory method for creating a registered account event template. @returns An Account event template instance

    Declaration

    Objective-C

    + (nonnull instancetype)registeredTemplate;

    Swift

    class func registered() -> Self
  • Factory method for creating a registered account event template with a value from a string.

    Declaration

    Objective-C

    + (nonnull instancetype)registeredTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func registeredTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    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. @returns An Account event template instance

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

    Declaration

    Objective-C

    + (nonnull instancetype)registeredTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func registeredTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event. @returns An Account event template instance

  • Factory method for creating a logged in account event template. @returns An Account event template instance

    Declaration

    Objective-C

    + (nonnull instancetype)loggedInTemplate;

    Swift

    class func loggedIn() -> Self
  • Factory method for creating a logged in account event template with a value from a string.

    Declaration

    Objective-C

    + (nonnull instancetype)loggedInTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func loggedInTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    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. @returns An Account event template instance

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

    Declaration

    Objective-C

    + (nonnull instancetype)loggedInTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func loggedInTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event. @returns An Account event template instance

  • Factory method for creating a logged out account event template. @returns An Account event template instance

    Declaration

    Objective-C

    + (nonnull instancetype)loggedOutTemplate;

    Swift

    class func loggedOut() -> Self
  • Factory method for creating a logged out account event template with a value from a string.

    Declaration

    Objective-C

    + (nonnull instancetype)loggedOutTemplateWithValueFromString:
        (nullable NSString *)eventValue;

    Swift

    class func loggedOutTemplateWithValue(from eventValue: String?) -> Self

    Parameters

    eventValue

    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. @returns An Account event template instance

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

    Declaration

    Objective-C

    + (nonnull instancetype)loggedOutTemplateWithValue:
        (nullable NSNumber *)eventValue;

    Swift

    class func loggedOutTemplate(withValue eventValue: NSNumber?) -> Self

    Parameters

    eventValue

    The value of the event. The value must be between -2^31 and 2^31 - 1 or it will invalidate the event. @returns An Account event template instance

  • Creates the custom account event.

    Declaration

    Objective-C

    - (nonnull UACustomEvent *)createEvent;

    Swift

    func createEvent() -> UACustomEvent