Class AirshipChannel

Airship channel.

Index

Constructors

Methods

addTag editAttributes editSubscriptionLists editTagGroups editTags enableChannelCreation getChannelId getSubscriptionLists getTags removeTag waitForChannelId

Constructors

constructor

new AirshipChannel(module: any): AirshipChannel
Parameters
- module: any
Returns AirshipChannel
- Defined in src/AirshipChannel.ts:12

Methods

addTag

addTag(tag: string): Promise<void>
Adds a device tag. Deprecated. Use editTags() instead.
Parameters
- tag: string
  The tag.
Returns Promise<void>
A promise.
- Defined in src/AirshipChannel.ts:30

editAttributes

editAttributes(): AttributeEditor
Edits attributes.

Returns AttributeEditor
An attribute editor.
- Defined in src/AirshipChannel.ts:103

editSubscriptionLists

editSubscriptionLists(): SubscriptionListEditor
Edits subscription lists.

Returns SubscriptionListEditor
A subscription list editor.
- Defined in src/AirshipChannel.ts:113

editTagGroups

editTagGroups(): TagGroupEditor
Edits tag groups.

Returns TagGroupEditor
A tag group editor.
- Defined in src/AirshipChannel.ts:93

editTags

editTags(): TagEditor
Edits device tags.

Returns TagEditor
A tag editor.
- Defined in src/AirshipChannel.ts:48

enableChannelCreation

enableChannelCreation(): Promise<void>
Enables channel creation if channel creation has been delayed. It is only necessary to call this when isChannelCreationDelayEnabled has been set to true in the airship config. Deprecated. Use the Private Manager to disable all features instead.

Returns Promise<void>
- Defined in src/AirshipChannel.ts:20

getChannelId

getChannelId(): Promise<string | null | undefined>
Gets the channel Id.

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

getSubscriptionLists

getSubscriptionLists(): Promise<string[]>
Gets a list of the channel's subscriptions.

Returns Promise<string[]>
A promise with the result.
- Defined in src/AirshipChannel.ts:85

getTags

getTags(): Promise<string[]>
Gets the device tags.

Returns Promise<string[]>
A promise with the result.
- Defined in src/AirshipChannel.ts:58

removeTag

removeTag(tag: string): Promise<void>
Removes a device tag. Deprecated. Use editTags() instead.
Parameters
- tag: string
  The tag.
Returns Promise<void>
A promise.
- Defined in src/AirshipChannel.ts:40

waitForChannelId

waitForChannelId(): Promise<string | null | undefined>
Returns the channel ID. If the channel ID is not yet created the function it will wait for it before returning. After the channel ID is created, this method functions the same as getChannelId().

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