Class UserModule

constructor

• new UserModule(): UserModule

• Returns UserModule

BatchUserAttributeType

clearInstallationData

• clearInstallationData(): void

• Clear all tags and attributes set on an installation and their local cache returned by getAttributes and getTagCollections. This does not affect data set on profiles using batch.profile.

  Returns void

getAttributes

• getAttributes(): Promise<{
      [key: string]: BatchSDK.BatchUserAttribute;
  }>

• Read the saved attributes. Reading is asynchronous so as not to interfere with saving operations.

  Returns Promise<{
      [key: string]: BatchSDK.BatchUserAttribute;
  }>

getIdentifier

• getIdentifier(): Promise<undefined | string>

• Get the user identifier set using BatchUserDataEditor. Batch must be started to read it. The promise will return the user identifier you have previously set, if any, or undefined. Might be null/undefined if Batch isn't started.

  Returns Promise<undefined | string>

getInstallationID

• getInstallationID(): Promise<undefined | string>

• Get the unique installation ID, generated by Batch. Batch must be started to read it. The promise will return the Batch-generated installation ID. Might be null/undefined if Batch isn't started.

  Returns Promise<undefined | string>

getLanguage

• getLanguage(): Promise<undefined | string>

• Get the application language override set using BatchUserDataEditor. Batch must be started to read it. The promise will return the language you have previously set, if any, or undefined. Might be null/undefined if Batch isn't started. Might throw if Batch isn't started.

  Returns Promise<undefined | string>

getRegion

• getRegion(): Promise<undefined | string>

• Get the application region override set using BatchUserDataEditor. Batch must be started to read it. The promise will return the region you have previously set, if any, or undefined. Might be null/undefined if Batch isn't started.

  Returns Promise<undefined | string>

getTagCollections

• getTagCollections(): Promise<{
      [key: string]: string[];
  }>

• Read the saved tag collections. Reading is asynchronous so as not to interfere with saving operations.

  Returns Promise<{
      [key: string]: string[];
  }>