Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BatchSDK

Index

Enumerations

Interfaces

Type aliases

Type aliases

EventAttributeValue

EventAttributeValue: { type: BOOLEAN; value: boolean | number } | { type: STRING; value: string } | { type: URL; value: string | URL } | { type: INTEGER; value: number | `${number}` } | { type: FLOAT; value: number | `${number}` } | { type: DATE; value: Date } | { type: ARRAY; value: (string | EventObjectAttributeValueType)[] } | { type: OBJECT; value: EventObjectAttributeValueType }

EventDataAttributeType

EventDataAttributeType: { $label: string; $tags: string[] }

Event data attribute type

Some event attributes have reserved keys, and are all prefixed by a $ sign. This is the list of currently reserved event attributes. You cannot set an event attribute starting by a $ sign.

Type declaration

  • [key: string]: string | boolean | number | URL | Date | (string | EventObjectAttributeValueType)[] | EventObjectAttributeValueType | EventAttributeValue

    All event's attributes.

  • $label: string

    Event label. Must be a string, will automatically be bridged as label for application event compatibility. Must not be longer than 200 characters

  • $tags: string[]

    Event tags. Must be an array of string, will automatically be bridged as tags for application event compatibility. Strings must not be longer than 64 characters and array must not be longer than 10 items.

EventDataParams

EventDataParams: { attributes?: EventDataAttributeType }

Type declaration

  • Optional attributes?: EventDataAttributeType

    Event attributes. Keys are the attribute names. Some keys are documented as they're reserved. See EventDataAttributeType for more info.

EventObjectAttributeValueType

EventObjectAttributeValueType: {}

Type declaration

ISafariConfig

ISafariConfig: {}

SDK Safari Configuration

Type declaration

  • [key: string]: string

ProfileAttributeValue

ProfileAttributeValue: ProfileTypedAttributeValue | string | boolean | number | URL | Date | string[] | null | undefined

ProfileTypedAttributeValue

ProfileTypedAttributeValue: { type: BOOLEAN; value: boolean | number } | { type: STRING; value: string } | { type: URL; value: string | URL } | { type: INTEGER; value: number | `${number}` } | { type: FLOAT; value: number | `${number}` } | { type: DATE; value: Date } | { type: ARRAY; value: string[] }

UserAttributeValue

UserAttributeValue: { type: BOOLEAN; value: boolean | number } | { type: STRING; value: string } | { type: URL; value: string | URL } | { type: INTEGER; value: number | `${number}` } | { type: FLOAT; value: number | `${number}` } | { type: DATE; value: Date }

Generated using TypeDoc