Interface AirshipMessageCenter

Airship Message Center

Hierarchy

AirshipMessageCenter

Index

Methods

deleteMessage dismiss display getMessages getUnreadCount markMessageRead onDisplay onUpdated refreshMessages setAutoLaunchDefaultMessageCenter showMessageView

Methods

deleteMessage

deleteMessage(messageId: string, success?: (() => void), error?: ((err: string) => void)): void
Deletes a message.
Parameters
- messageId: string
  
  The message Id.
- 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:1495

dismiss

dismiss(success?: (() => void), error?: ((err: string) => void)): void
Dismisses the OOTB message center if displayed.
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:1506

display

display(messageId?: string, success?: (() => void), error?: ((err: string) => void)): void
Requests to display the Message Center.

Will either emit an event to display the Message Center if auto launch message center is disabled, or display the OOTB message center.
Parameters
- Optional messageId: string
  
  Optional message Id.
- 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:1521

getMessages

getMessages(success: ((messages: InboxMessage[]) => void), error?: ((err: string) => void)): void
Gets the inbox messages.
Parameters
- success: ((messages: InboxMessage[]) => void)
  
  Success callback.
  - - (messages: InboxMessage[]): void
    - Parameters
      
      messages: InboxMessage[]
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1472

getUnreadCount

getUnreadCount(success: ((count: number) => void), error?: ((err: string) => void)): void
Gets the unread count.
Parameters
- success: ((count: number) => void)
  
  Success callback.
  - - (count: number): void
    - Parameters
      
      count: number
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1462

markMessageRead

markMessageRead(messageId: string, success?: (() => void), error?: ((err: string) => void)): void
Marks a message as read.
Parameters
- messageId: string
  
  The message Id.
- 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:1483

onDisplay

onDisplay(callback: ((event: DisplayMessageCenterEvent) => void)): Cancellable
Event when the message center is requested to be displayed.

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

onUpdated

onUpdated(callback: ((event: MessageCenterUpdatedEvent) => void)): Cancellable
Event when the message list is updated.

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

refreshMessages

refreshMessages(success?: (() => void), error?: ((err: string) => void)): void
Refreshes the messages.
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:1546

setAutoLaunchDefaultMessageCenter

setAutoLaunchDefaultMessageCenter(autoLaunch: boolean): void
Enables or disables showing the OOTB UI when requested to display by either display or by a notification with a Message Center action.
Parameters
- autoLaunch: boolean
  
  true to show OOTB UI, false to emit events.
Returns void
- Defined in index.d.ts:1556

showMessageView

showMessageView(messageId: string, success?: (() => void), error?: ((err: string) => void)): void
Overlays the message view. Should be used to display the actual message body in a custom Message Center.
Parameters
- messageId: string
  
  The message Id.
- 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:1535

Interface AirshipMessageCenter

Hierarchy

Index

Methods

Methods

deleteMessage

Parameters

messageId: string

Optional success: (() => void)

Returns void

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

Parameters

err: string

Returns void

Returns void

dismiss

Parameters

Optional success: (() => void)

Returns void

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

Parameters

err: string

Returns void

Returns void

display

Parameters

Optional messageId: string

Optional success: (() => void)

Returns void

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

Parameters

err: string

Returns void

Returns void

getMessages

Parameters

success: ((messages: InboxMessage[]) => void)

Parameters

messages: InboxMessage[]

Returns void

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

Parameters

err: string

Returns void

Returns void

getUnreadCount

Parameters

success: ((count: number) => void)

Parameters

count: number

Returns void

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

Parameters

err: string

Returns void

Returns void

markMessageRead

Parameters

messageId: string

Optional success: (() => void)

Returns void

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

Parameters

err: string

Returns void

Returns void

onDisplay

Returns

Parameters

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

Parameters

event: DisplayMessageCenterEvent

Returns void

Returns Cancellable

onUpdated

Returns

Parameters

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

Parameters

event: MessageCenterUpdatedEvent

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

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

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

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

`Optional` messageId: string

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

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

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

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

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

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

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

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

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

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