Class AirshipLiveActivityManager

Live Activity manager.

Index

Constructors

Properties

Methods

end list listAll start update

Constructors

constructor

new AirshipLiveActivityManager(module): AirshipLiveActivityManager
Parameters
- module: any
Returns AirshipLiveActivityManager
- Defined in src/AirshipLiveActivityManager.ts:13

Properties

`Private` `Readonly` module

module: any

Methods

end

end(request): Promise<void>
Ends a Live Activity.
Parameters
- request: LiveActivityEndRequest
  The request options.
Returns Promise<void>
A promise with the result.
- Defined in src/AirshipLiveActivityManager.ts:56

list

list(request): Promise<LiveActivity[]>
Lists any Live Activities for the request.
Parameters
- request: LiveActivityListRequest
  The request options.
Returns Promise<LiveActivity[]>
A promise with the result.
- Defined in src/AirshipLiveActivityManager.ts:20

listAll

listAll(): Promise<LiveActivity[]>
Lists all Live Activities.

Returns Promise<LiveActivity[]>
A promise with the result.
- Defined in src/AirshipLiveActivityManager.ts:29

start

start(request): Promise<LiveActivity>
Starts a Live Activity.
Parameters
- request: LiveActivityStartRequest
  The request options.
Returns Promise<LiveActivity>
A promise with the result.
- Defined in src/AirshipLiveActivityManager.ts:38

update

update(request): Promise<void>
Updates a Live Activity.
Parameters
- request: LiveActivityUpdateRequest
  The request options.
Returns Promise<void>
A promise with the result.
- Defined in src/AirshipLiveActivityManager.ts:47