@cliffhelsel/capacitor-live-activity

{ "api": { "name": "LiveActivityPlugin", "slug": "liveactivityplugin", "docs": "", "tags": [], "methods": [ { "name": "startActivity", "signature": "(options: StartActivityOptions) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "StartActivityOptions" } ], "returns": "Promise<void>", "tags": [ { "name": "since", "text": "0.0.1" }, { "name": "platform", "text": "iOS" } ], "docs": "Starts a new Live Activity on iOS using the provided options.", "complexTypes": [ "StartActivityOptions" ], "slug": "startactivity" }, { "name": "startObservingPushToStartToken", "signature": "() => Promise<void>", "parameters": [], "returns": "Promise<void>", "tags": [], "docs": "", "complexTypes": [], "slug": "startobservingpushtostarttoken" }, { "name": "addListener", "signature": "(eventName: 'pushToStartToken', listenerFunc: (data: { token: string; }) => void) => Promise<PluginListenerHandle>", "parameters": [ { "name": "eventName", "docs": "", "type": "'pushToStartToken'" }, { "name": "listenerFunc", "docs": "", "type": "(data: { token: string; }) => void" } ], "returns": "Promise<PluginListenerHandle>", "tags": [], "docs": "", "complexTypes": [ "PluginListenerHandle" ], "slug": "addlistenerpushtostarttoken-" }, { "name": "updateActivity", "signature": "(options: UpdateActivityOptions) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "UpdateActivityOptions" } ], "returns": "Promise<void>", "tags": [ { "name": "since", "text": "0.0.1" }, { "name": "platform", "text": "iOS" } ], "docs": "Updates the currently active Live Activity.", "complexTypes": [ "UpdateActivityOptions" ], "slug": "updateactivity" }, { "name": "endActivity", "signature": "(options: EndActivityOptions) => Promise<void>", "parameters": [ { "name": "options", "docs": "", "type": "EndActivityOptions" } ], "returns": "Promise<void>", "tags": [ { "name": "since", "text": "0.0.1" }, { "name": "platform", "text": "iOS" } ], "docs": "Ends the Live Activity and optionally provides a final state and dismissal policy.", "complexTypes": [ "EndActivityOptions" ], "slug": "endactivity" }, { "name": "isAvailable", "signature": "() => Promise<boolean>", "parameters": [], "returns": "Promise<boolean>", "tags": [ { "name": "since", "text": "0.0.1" }, { "name": "platform", "text": "iOS" } ], "docs": "Returns whether Live Activities are available on this device and allowed by the user.", "complexTypes": [], "slug": "isavailable" }, { "name": "isRunning", "signature": "(options: { id: string; }) => Promise<boolean>", "parameters": [ { "name": "options", "docs": "", "type": "{ id: string; }" } ], "returns": "Promise<boolean>", "tags": [ { "name": "since", "text": "0.0.1" }, { "name": "platform", "text": "iOS" } ], "docs": "Returns true if a Live Activity with the given ID is currently running.", "complexTypes": [], "slug": "isrunning" }, { "name": "getCurrentActivity", "signature": "(options?: { id?: string | undefined; } | undefined) => Promise<LiveActivityState | undefined>", "parameters": [ { "name": "options", "docs": "", "type": "{ id?: string | undefined; } | undefined" } ], "returns": "Promise<LiveActivityState | undefined>", "tags": [ { "name": "since", "text": "0.0.1" }, { "name": "platform", "text": "iOS" } ], "docs": "Returns the current active Live Activity state, if any.\n\nIf an ID is provided, returns that specific activity.\nIf no ID is given, returns the most recently started activity.", "complexTypes": [ "LiveActivityState" ], "slug": "getcurrentactivity" } ], "properties": [] }, "interfaces": [ { "name": "StartActivityOptions", "slug": "startactivityoptions", "docs": "Options for starting a Live Activity.", "tags": [], "methods": [], "properties": [ { "name": "id", "tags": [], "docs": "Unique ID to identify the Live Activity.", "complexTypes": [], "type": "string" }, { "name": "attributes", "tags": [], "docs": "Immutable attributes that are part of the Live Activity.", "complexTypes": [ "Record" ], "type": "Record<string, string>" }, { "name": "contentState", "tags": [], "docs": "Initial content state (dynamic values).", "complexTypes": [ "Record" ], "type": "Record<string, string>" }, { "name": "timestamp", "tags": [], "docs": "Optional timestamp (Unix) when the Live Activity started.", "complexTypes": [], "type": "number | undefined" } ] }, { "name": "PluginListenerHandle", "slug": "pluginlistenerhandle", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "remove", "tags": [], "docs": "", "complexTypes": [], "type": "() => Promise<void>" } ] }, { "name": "UpdateActivityOptions", "slug": "updateactivityoptions", "docs": "Options for updating a Live Activity.", "tags": [], "methods": [], "properties": [ { "name": "id", "tags": [], "docs": "ID of the Live Activity to update.", "complexTypes": [], "type": "string" }, { "name": "contentState", "tags": [], "docs": "Updated content state (dynamic values).", "complexTypes": [ "Record" ], "type": "Record<string, string>" }, { "name": "alert", "tags": [], "docs": "Optional alert configuration to show a notification banner or Apple Watch alert.", "complexTypes": [ "AlertConfiguration" ], "type": "AlertConfiguration" }, { "name": "timestamp", "tags": [], "docs": "Optional timestamp (Unix) when the update occurred.", "complexTypes": [], "type": "number | undefined" } ] }, { "name": "AlertConfiguration", "slug": "alertconfiguration", "docs": "Configuration for alert notifications.", "tags": [], "methods": [], "properties": [ { "name": "title", "tags": [], "docs": "Optional title of the alert.", "complexTypes": [], "type": "string | undefined" }, { "name": "body", "tags": [], "docs": "Optional body text of the alert.", "complexTypes": [], "type": "string | undefined" }, { "name": "sound", "tags": [], "docs": "Optional sound file name or \"default\".", "complexTypes": [], "type": "string | undefined" } ] }, { "name": "EndActivityOptions", "slug": "endactivityoptions", "docs": "Options for ending a Live Activity.", "tags": [], "methods": [], "properties": [ { "name": "id", "tags": [], "docs": "ID of the Live Activity to end.", "complexTypes": [], "type": "string" }, { "name": "contentState", "tags": [], "docs": "Final state to show before dismissal.", "complexTypes": [ "Record" ], "type": "Record<string, string>" }, { "name": "timestamp", "tags": [], "docs": "Optional timestamp (Unix) when the end occurred.", "complexTypes": [], "type": "number | undefined" }, { "name": "dismissalDate", "tags": [], "docs": "Optional dismissal time in the future (Unix). If not provided, system default applies.", "complexTypes": [], "type": "number | undefined" } ] }, { "name": "LiveActivityState", "slug": "liveactivitystate", "docs": "Represents an active Live Activity state.", "tags": [], "methods": [], "properties": [ { "name": "id", "tags": [], "docs": "The unique identifier of the activity.", "complexTypes": [], "type": "string" }, { "name": "values", "tags": [], "docs": "The current dynamic values of the activity.", "complexTypes": [ "Record" ], "type": "Record<string, string>" }, { "name": "isStale", "tags": [], "docs": "Whether the activity is stale.", "complexTypes": [], "type": "boolean" }, { "name": "isEnded", "tags": [], "docs": "Whether the activity has ended.", "complexTypes": [], "type": "boolean" }, { "name": "startedAt", "tags": [], "docs": "ISO string timestamp when the activity started.", "complexTypes": [], "type": "string" } ] } ], "enums": [], "typeAliases": [ { "name": "Record", "slug": "record", "docs": "Construct a type with a set of properties K of type T", "types": [ { "text": "{\r\n [P in K]: T;\r\n}", "complexTypes": [ "K", "T" ] } ] } ], "pluginConfigs": [] }