Class AirshipContact

Airship contact.

Hierarchy

AirshipContact

Index

Constructors

Properties

Methods

editAttributes editSubscriptionLists editTagGroups getNamedUserId getSubscriptionLists identify registerEmail registerSms reset

Constructors

constructor

new AirshipContact(plugin: AirshipPluginWrapper): AirshipContact
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipContact
- Defined in AirshipContact.ts:17

Properties

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

Methods

editAttributes

editAttributes(): AttributeEditor
Edits attributes.

Returns
An attribute editor.

Returns AttributeEditor
- Defined in AirshipContact.ts:86

editSubscriptionLists

editSubscriptionLists(): ScopedSubscriptionListEditor
Edits subscription lists.

Returns
A subscription list editor.

Returns ScopedSubscriptionListEditor
- Defined in AirshipContact.ts:96

editTagGroups

editTagGroups(): TagGroupEditor
Edits tag groups.

Returns
A tag group editor.

Returns TagGroupEditor
- Defined in AirshipContact.ts:76

getNamedUserId

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

Returns
A promise with the result.

Returns Promise<undefined | null | string>
- Defined in AirshipContact.ts:60

getSubscriptionLists

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

Returns
A promise with the result.

Returns Promise<Record<string, SubscriptionScope[]>>
- Defined in AirshipContact.ts:68

identify

identify(namedUser: string): Promise<void>
Identifies the contact with a named user Id.

Returns
A promise.
Parameters
- namedUser: string
  
  The named user Id.
Returns Promise<void>
- Defined in AirshipContact.ts:24

registerEmail

registerEmail(address: string, options: EmailRegistrationOptions): Promise<void>
Registers an email channel with the contact.

Returns
A promise.
Parameters
- address: string
  
  The email address.
- options: EmailRegistrationOptions
  
  The email registration options.
Returns Promise<void>
- Defined in AirshipContact.ts:52

registerSms

registerSms(msisdn: string, options: SmsRegistrationOptions): Promise<void>
Registers an SMS channel with the contact.

Returns
A promise.
Parameters
- msisdn: string
  
  The phone number in E.164 format.
- options: SmsRegistrationOptions
  
  The SMS registration options.
Returns Promise<void>
- Defined in AirshipContact.ts:42

reset

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

Returns
A promise.

Returns Promise<void>
- Defined in AirshipContact.ts:32

Generated using TypeDoc