Class AirshipContact

Airship contact.

Index

Constructors

Properties

Methods

editAttributes editSubscriptionLists editTagGroups getNamedUserId getSubscriptionLists identify notifyRemoteLogin reset

Constructors

constructor

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

Properties

`Private` `Readonly` module

module: any

Methods

editAttributes

editAttributes(): AttributeEditor
Edits attributes.

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

editSubscriptionLists

editSubscriptionLists(): ScopedSubscriptionListEditor
Edits subscription lists.

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

editTagGroups

editTagGroups(): TagGroupEditor
Edits tag groups.

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

getNamedUserId

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

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

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:52

identify

identify(namedUser): 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:36

reset

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

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