Class AirshipMessageCenter

Airship Message Center

Index

Constructors

Properties

Methods

deleteMessage dismiss display getMessages getUnreadCount markMessageRead refreshMessages setAutoLaunchDefaultMessageCenter

Constructors

constructor

new AirshipMessageCenter(module): AirshipMessageCenter
Parameters
- module: any
Returns AirshipMessageCenter
- Defined in src/AirshipMessageCenter.ts:7

Properties

`Private` `Readonly` module

module: any

Methods

deleteMessage

deleteMessage(messageId): Promise<void>
Deletes a message.
Parameters
- messageId: string
  The message Id.
Returns Promise<void>
A promise. Will reject if the message is not found or if takeOff is not called.
- Defined in src/AirshipMessageCenter.ts:41

dismiss

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

Returns Promise<void>
A promise.
- Defined in src/AirshipMessageCenter.ts:49

display

display(messageId?): 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.
Parameters
- Optional messageId: string
  Optional message Id.
Returns Promise<void>
A promise.
- Defined in src/AirshipMessageCenter.ts:62

getMessages

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

Returns Promise<InboxMessage[]>
A promise with the result.
- Defined in src/AirshipMessageCenter.ts:21

getUnreadCount

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

Returns Promise<number>
A promise with the result.
- Defined in src/AirshipMessageCenter.ts:13

markMessageRead

markMessageRead(messageId): Promise<void>
Marks a message as read.
Parameters
- messageId: string
  The message Id.
Returns Promise<void>
A promise. Will reject if the message is not found or if takeOff is not called.
- Defined in src/AirshipMessageCenter.ts:31

refreshMessages

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

Returns Promise<void>
A promise. Will reject if the list fails to refresh or if takeOff is not called yet.
- Defined in src/AirshipMessageCenter.ts:71

setAutoLaunchDefaultMessageCenter

setAutoLaunchDefaultMessageCenter(autoLaunch): 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 src/AirshipMessageCenter.ts:80