Interface AirshipLiveActivityManager

Live Activity manager. iOS only.

Hierarchy

AirshipLiveActivityManager

Index

Methods

end list listAll onLiveActivitiesUpdated start update

Methods

end

end(request: LiveActivityEndRequest, success?: (() => void), error?: ((err: string) => void)): void
Ends a Live Activity.
Parameters
- request: LiveActivityEndRequest
  
  The request options.
- 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:2262

list

list(request: LiveActivityListRequest, success: ((activities: LiveActivity[]) => void), error?: ((err: string) => void)): void
Lists any Live Activities for the request.
Parameters
- request: LiveActivityListRequest
  
  The request options.
- success: ((activities: LiveActivity[]) => void)
  
  Success callback with the list.
  - - (activities: LiveActivity[]): void
    - Parameters
      
      activities: LiveActivity[]
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2216

listAll

listAll(success: ((activities: LiveActivity[]) => void), error?: ((err: string) => void)): void
Lists all Live Activities.
Parameters
- success: ((activities: LiveActivity[]) => void)
  
  Success callback with the list.
  - - (activities: LiveActivity[]): void
    - Parameters
      
      activities: LiveActivity[]
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2227

onLiveActivitiesUpdated

onLiveActivitiesUpdated(callback: ((event: LiveActivitiesUpdatedEvent) => void)): Cancellable
Live Activities updated listener.

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

start

start(request: LiveActivityStartRequest, success: ((activity: LiveActivity) => void), error?: ((err: string) => void)): void
Starts a Live Activity.
Parameters
- request: LiveActivityStartRequest
  
  The request options.
- success: ((activity: LiveActivity) => void)
  
  Success callback with the started activity.
  - - (activity: LiveActivity): void
    - Parameters
      
      activity: LiveActivity
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:2238

update

update(request: LiveActivityUpdateRequest, success?: (() => void), error?: ((err: string) => void)): void
Updates a Live Activity.
Parameters
- request: LiveActivityUpdateRequest
  
  The request options.
- 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:2250

Interface AirshipLiveActivityManager

Hierarchy

Index

Methods

Methods

end

Parameters

request: LiveActivityEndRequest

Optional success: (() => void)

Returns void

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

Parameters

err: string

Returns void

Returns void

list

Parameters

request: LiveActivityListRequest

success: ((activities: LiveActivity[]) => void)

Parameters

activities: LiveActivity[]

Returns void

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

Parameters

err: string

Returns void

Returns void

listAll

Parameters

success: ((activities: LiveActivity[]) => void)

Parameters

activities: LiveActivity[]

Returns void

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

Parameters

err: string

Returns void

Returns void

onLiveActivitiesUpdated

Returns

Parameters

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

Parameters

event: LiveActivitiesUpdatedEvent

Returns void

Returns Cancellable

start

Parameters

request: LiveActivityStartRequest

success: ((activity: LiveActivity) => void)

Parameters

activity: LiveActivity

Returns void

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

Parameters

err: string

Returns void

Returns void

update

Parameters

request: LiveActivityUpdateRequest

Optional success: (() => void)

Returns void

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

Parameters

err: string

Returns void

Returns void

Settings

Member Visibility

Theme

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

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

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

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

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

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

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