Interface PushLiveActivityStartParams

Parameters for start.

Hierarchy

  • PushLiveActivityStartParams

Properties

apns apnsBroadcast headers? recipient

Properties

apns

apns: any

A valid APNs Live Activity start payload. The payload is passed through to APNs as-is.

apnsBroadcast

apnsBroadcast: string

The id returned from createApnsBroadcast.

Optional headers

headers?: Record<string, string>

Optional APNs delivery headers, such as apns-priority and apns-expiration. When supplied, these are included in the request body under a headers key.

recipient

recipient: {
    channels: string[];
} | {
    deviceId: string;
}

The targeted recipients of the push-to-start notification.

Type declaration

  • channels: string[]

    One or more Ably channel names. Devices subscribed to any of these channels will receive the push-to-start notification. Provide either channels or deviceId.

Type declaration

  • deviceId: string

    Restrict the push-to-start notification to a single device. Provide either channels or deviceId.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc