Class AirshipChannel

Airship channel.

Hierarchy

AirshipChannel

Index

Constructors

Properties

Methods

editAttributes editSubscriptionLists editTagGroups editTags enableChannelCreation getChannelId getSubscriptionLists getTags onChannelCreated waitForChannelId

Constructors

constructor

new AirshipChannel(plugin: AirshipPluginWrapper): AirshipChannel
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipChannel
- Defined in AirshipChannel.ts:25

Properties

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

Methods

editAttributes

editAttributes(): AttributeEditor
Edits attributes.

Returns
An attribute editor.

Returns AttributeEditor
- Defined in AirshipChannel.ts:85

editSubscriptionLists

editSubscriptionLists(): SubscriptionListEditor
Edits subscription lists.

Returns
A subscription list editor.

Returns SubscriptionListEditor
- Defined in AirshipChannel.ts:95

editTagGroups

editTagGroups(): TagGroupEditor
Edits tag groups.

Returns
A tag group editor.

Returns TagGroupEditor
- Defined in AirshipChannel.ts:75

editTags

editTags(): TagEditor
Edits tags.

Returns
A tag group editor.

Returns TagEditor
- Defined in AirshipChannel.ts:66

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 AirshipChannel.ts:109

getChannelId

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

Returns
A promise with the result.

Returns Promise<undefined | null | string>
- Defined in AirshipChannel.ts:40

getSubscriptionLists

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

Returns
A promise with the result.

Returns Promise<string[]>
- Defined in AirshipChannel.ts:58

getTags

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

Returns
A promise with the result.

Returns Promise<string[]>
- Defined in AirshipChannel.ts:31

onChannelCreated

onChannelCreated(listener: ((event: ChannelCreatedEvent) => void)): Promise<PluginListenerHandle>
Adds a channel created listener
Parameters
- listener: ((event: ChannelCreatedEvent) => void)
  - - (event: ChannelCreatedEvent): void
    - Parameters
      
      event: ChannelCreatedEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipChannel.ts:116

waitForChannelId

waitForChannelId(): Promise<string>
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
A promise with the result.

Returns Promise<string>
- Defined in AirshipChannel.ts:50

Generated using TypeDoc