Interface PushLiveActivityExperimental

Controls the lifecycle of an iOS Live Activity over an APNs broadcast channel.

This is a preview feature and may change in a future non-major release.

Hierarchy

  • PushLiveActivity

Methods

Methods

  • Experimental

    Ends the Live Activity on all subscribed devices and cleans up the APNs channel. After this call, the broadcast id is no longer valid.

    This is a preview feature and may change in a future non-major release.

    Parameters

    Returns Promise<void>

    A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.

  • Experimental

    Sends a push-to-start notification to all devices subscribed to the given Ably channels. Each targeted device starts a new Live Activity using its registered push-to-start token.

    This is a preview feature and may change in a future non-major release.

    Parameters

    Returns Promise<void>

    A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.

  • Experimental

    Sends a content-state update to all devices with an active Live Activity on the broadcast channel. A single push is sent to the channel; APNs handles fan-out to all subscribed devices.

    This is a preview feature and may change in a future non-major release.

    Parameters

    Returns Promise<void>

    A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.

Generated using TypeDoc