Class AirshipLiveActivityManager

Live Activity manager.

Hierarchy

AirshipLiveActivityManager

Index

Constructors

Properties

Methods

end list listAll onLiveActivityUpdates start update

Constructors

constructor

new AirshipLiveActivityManager(plugin: AirshipPluginWrapper): AirshipLiveActivityManager
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipLiveActivityManager
- Defined in AirshipLiveActivityManager.ts:18

Properties

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

Methods

end

end(request: LiveActivityEndRequest): Promise<void>
Ends a Live Activity.

Returns
A promise with the result.
Parameters
- request: LiveActivityEndRequest
  
  The request options.
Returns Promise<void>
- Defined in AirshipLiveActivityManager.ts:61

list

list(request: LiveActivityListRequest): Promise<LiveActivity[]>
Lists any Live Activities for the request.

Returns
A promise with the result.
Parameters
- request: LiveActivityListRequest
  
  The request options.
Returns Promise<LiveActivity[]>
- Defined in AirshipLiveActivityManager.ts:25

listAll

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

Returns
A promise with the result.

Returns Promise<LiveActivity[]>
- Defined in AirshipLiveActivityManager.ts:34

onLiveActivityUpdates

onLiveActivityUpdates(listener: ((event: LiveActivitiesUpdatedEvent) => void)): Promise<PluginListenerHandle>
Adds a Live Activity listener.
Parameters
- listener: ((event: LiveActivitiesUpdatedEvent) => void)
  - - (event: LiveActivitiesUpdatedEvent): void
    - Parameters
      
      event: LiveActivitiesUpdatedEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipLiveActivityManager.ts:68

start

start(request: LiveActivityStartRequest): Promise<LiveActivity>
Starts a Live Activity.

Returns
A promise with the result.
Parameters
- request: LiveActivityStartRequest
  
  The request options.
Returns Promise<LiveActivity>
- Defined in AirshipLiveActivityManager.ts:43

update

update(request: LiveActivityUpdateRequest): Promise<void>
Updates a Live Activity.

Returns
A promise with the result.
Parameters
- request: LiveActivityUpdateRequest
  
  The request options.
Returns Promise<void>
- Defined in AirshipLiveActivityManager.ts:52

Generated using TypeDoc