Class AirshipContact

Airship contact.

Index

Constructors

Methods

editAttributes editSubscriptionLists editTagGroups getNamedUserId getSubscriptionLists identify notifyRemoteLogin registerEmail registerSms reset

Constructors

constructor

new AirshipContact(module: any): AirshipContact
Parameters
- module: any
Returns AirshipContact
- Defined in src/AirshipContact.ts:13

Methods

editAttributes

editAttributes(): AttributeEditor
Edits attributes.

Returns AttributeEditor
An attribute editor.
- Defined in src/AirshipContact.ts:90

editSubscriptionLists

editSubscriptionLists(): ScopedSubscriptionListEditor
Edits subscription lists.

Returns ScopedSubscriptionListEditor
A subscription list editor.
- Defined in src/AirshipContact.ts:100

editTagGroups

editTagGroups(): TagGroupEditor
Edits tag groups.

Returns TagGroupEditor
A tag group editor.
- Defined in src/AirshipContact.ts:80

getNamedUserId

getNamedUserId(): Promise<string | null | undefined>
Gets the named user Id.

Returns Promise<string | null | undefined>
A promise with the result.
- Defined in src/AirshipContact.ts:64

getSubscriptionLists

getSubscriptionLists(): Promise<Record<string, SubscriptionScope[]>>
Gets the contacts subscription lists.

Returns Promise<Record<string, SubscriptionScope[]>>
A promise with the result.
- Defined in src/AirshipContact.ts:72

identify

identify(namedUser: string): Promise<void>
Identifies the contact with a named user Id.
Parameters
- namedUser: string
  The named user Id.
Returns Promise<void>
A promise.
- Defined in src/AirshipContact.ts:20

notifyRemoteLogin

notifyRemoteLogin(): Promise<void>
Notifies the contact of a remote login.

Returns Promise<void>
A promise.
- Defined in src/AirshipContact.ts:56

registerEmail

registerEmail(address: string, options: EmailRegistrationOptions): Promise<void>
Registers an email channel with the contact.
Parameters
- address: string
  The email address.
- options: EmailRegistrationOptions
  The email registration options.
Returns Promise<void>
A promise.
- Defined in src/AirshipContact.ts:48

registerSms

registerSms(msisdn: string, options: SmsRegistrationOptions): Promise<void>
Registers an SMS channel with the contact.
Parameters
- msisdn: string
  The phone number in E.164 format.
- options: SmsRegistrationOptions
  The SMS registration options.
Returns Promise<void>
A promise.
- Defined in src/AirshipContact.ts:38

reset

reset(): Promise<void>
Resets the contact.

Returns Promise<void>
A promise.
- Defined in src/AirshipContact.ts:28