Class AirshipMessageCenter

Airship Message Center

Hierarchy

AirshipMessageCenter

Index

Constructors

Properties

Methods

deleteMessage dismiss display getMessages getUnreadCount markMessageRead onDisplay onUpdated refreshMessages setAutoLaunchDefaultMessageCenter showMessageView

Constructors

constructor

new AirshipMessageCenter(plugin: AirshipPluginWrapper): AirshipMessageCenter
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipMessageCenter
- Defined in AirshipMessageCenter.ts:15

Properties

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

Methods

deleteMessage

deleteMessage(messageId: string): Promise<void>
Deletes a message.

Returns
A promise. Will reject if the message is not found or if takeOff is not called.
Parameters
- messageId: string
  
  The message Id.
Returns Promise<void>
- Defined in AirshipMessageCenter.ts:49

dismiss

dismiss(): Promise<void>
Dismisses the OOTB message center if displayed.

Returns
A promise.

Returns Promise<void>
- Defined in AirshipMessageCenter.ts:57

display

display(messageId?: string): Promise<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.

Returns
A promise.
Parameters
- Optional messageId: string
  
  Optional message Id.
Returns Promise<void>
- Defined in AirshipMessageCenter.ts:70

getMessages

getMessages(): Promise<InboxMessage[]>
Gets the inbox messages.

Returns
A promise with the result.

Returns Promise<InboxMessage[]>
- Defined in AirshipMessageCenter.ts:29

getUnreadCount

getUnreadCount(): Promise<number>
Gets the unread count.

Returns
A promise with the result.

Returns Promise<number>
- Defined in AirshipMessageCenter.ts:21

markMessageRead

markMessageRead(messageId: string): Promise<void>
Marks a message as read.

Returns
A promise. Will reject if the message is not found or if takeOff is not called.
Parameters
- messageId: string
  
  The message Id.
Returns Promise<void>
- Defined in AirshipMessageCenter.ts:39

onDisplay

onDisplay(listener: ((event: DisplayMessageCenterEvent) => void)): Promise<PluginListenerHandle>
Adds a display message center listener.
Parameters
- listener: ((event: DisplayMessageCenterEvent) => void)
  - - (event: DisplayMessageCenterEvent): void
    - Parameters
      
      event: DisplayMessageCenterEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipMessageCenter.ts:109

onUpdated

onUpdated(listener: ((event: MessageCenterUpdatedEvent) => void)): Promise<PluginListenerHandle>
Adds a message center list updated listener.
Parameters
- listener: ((event: MessageCenterUpdatedEvent) => void)
  - - (event: MessageCenterUpdatedEvent): void
    - Parameters
      
      event: MessageCenterUpdatedEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipMessageCenter.ts:118

refreshMessages

refreshMessages(): Promise<void>
Refreshes the messages.

Returns
A promise. Will reject if the list fails to refresh or if takeOff is not called yet.

Returns Promise<void>
- Defined in AirshipMessageCenter.ts:90

setAutoLaunchDefaultMessageCenter

setAutoLaunchDefaultMessageCenter(autoLaunch: boolean): Promise<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 Promise<void>
- Defined in AirshipMessageCenter.ts:99

showMessageView

showMessageView(messageId: string): Promise<void>
Overlays the message view. Should be used to display the actual message body in a custom Message Center.

Returns
A promise.
Parameters
- messageId: string
  
  The message Id.
Returns Promise<void>
- Defined in AirshipMessageCenter.ts:81

Generated using TypeDoc