Interface AirshipChannel

Airship channel.

Hierarchy

AirshipChannel

Index

Methods

editAttributes editSubscriptionLists editTagGroups editTags enableChannelCreation getChannelId getSubscriptionLists getTags onChannelCreated

Methods

editAttributes

editAttributes(): AttributeEditor
Edits attributes.

Returns
An attribute editor.

Returns AttributeEditor
- Defined in index.d.ts:1835

editSubscriptionLists

editSubscriptionLists(): SubscriptionListEditor
Edits subscription lists.

Returns
A subscription list editor.

Returns SubscriptionListEditor
- Defined in index.d.ts:1841

editTagGroups

editTagGroups(): TagGroupEditor
Edits tag groups.

Returns
A tag group editor.

Returns TagGroupEditor
- Defined in index.d.ts:1829

editTags

editTags(): TagEditor
Edits device tags.

Returns
A tag editor.

Returns TagEditor
- Defined in index.d.ts:1793

enableChannelCreation

enableChannelCreation(success?: (() => void), error?: ((err: string) => void)): 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.
Parameters
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1784

getChannelId

getChannelId(success: ((channelId: undefined | null | string) => void), error?: ((err: string) => void)): void
Gets the channel Id.
Parameters
- success: ((channelId: undefined | null | string) => void)
  
  Success callback.
  - - (channelId: undefined | null | string): void
    - Parameters
      
      channelId: undefined | null | string
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1810

getSubscriptionLists

getSubscriptionLists(success: ((subscriptionLists: string[]) => void), error?: ((err: string) => void)): void
Gets a list of the channel's subscriptions.
Parameters
- success: ((subscriptionLists: string[]) => void)
  
  Success callback.
  - - (subscriptionLists: string[]): void
    - Parameters
      
      subscriptionLists: string[]
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1820

getTags

getTags(success: ((tags: string[]) => void), error?: ((err: string) => void)): void
Gets the device tags.
Parameters
- success: ((tags: string[]) => void)
  
  Success callback.
  - - (tags: string[]): void
    - Parameters
      
      tags: string[]
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1800

onChannelCreated

onChannelCreated(callback: ((event: ChannelCreatedEvent) => void)): Cancellable
Event when the channel (and channel Id) is created.

Returns
A cancellable that can be used to cancel the listener.
Parameters
- callback: ((event: ChannelCreatedEvent) => void)
  
  The callback.
  - - (event: ChannelCreatedEvent): void
    - Parameters
      
      event: ChannelCreatedEvent
      
      Returns void
Returns Cancellable
- Defined in index.d.ts:1849

Interface AirshipChannel

Hierarchy

Index

Methods

Methods

editAttributes

Returns

Returns AttributeEditor

editSubscriptionLists

Returns

Returns SubscriptionListEditor

editTagGroups

Returns

Returns TagGroupEditor

editTags

Returns

Returns TagEditor

enableChannelCreation

Parameters

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getChannelId

Parameters

success: ((channelId: undefined | null | string) => void)

Parameters

channelId: undefined | null | string

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getSubscriptionLists

Parameters

success: ((subscriptionLists: string[]) => void)

Parameters

subscriptionLists: string[]

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getTags

Parameters

success: ((tags: string[]) => void)

Parameters

tags: string[]

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

onChannelCreated

Returns

Parameters

callback: ((event: ChannelCreatedEvent) => void)

Parameters

event: ChannelCreatedEvent

Returns void

Returns Cancellable

Settings

Member Visibility

Theme

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)