Class ProfileModule

constructor

• new ProfileModule(): ProfileModule

• Returns ProfileModule

eventAttributes

getEditor

• getEditor(): BatchProfileAttributeEditor

• Get the user data editor. Don't forget to call save when you're done.

  Returns BatchProfileAttributeEditor

  Batch user data editor

identify

• identify(identifier): void

• Identifies this device with a profile using a Custom User ID. If a profile already exists, this device will be attached to it. Must not be longer than 1024 characters.

  Parameters

  • identifier: null | string

    Custom user ID of the profile you want to identify against. Null to remove.

  Returns void

trackEvent

• trackEvent(name, data?): Promise<undefined | string>

• Track an event. Batch must be started at some point, or events won't be sent to the server.

  Parameters

  • name: string

    The event name. Must be a string.
  • Optionaldata: BatchEventAttributes

    The event data (optional). Must be an object.

  Returns Promise<undefined | string>

trackLocation

• trackLocation(location): void

• Track a geolocation update You can call this method from any thread. Batch must be started at some point, or location updates won't be sent to the server.

  Parameters

  • location: Location

    User location object

  Returns void