Skip to content

IndeRunCapacitorApi

The plugin contract plus the ergonomic Mode 2 entry point. stream() is not a plugin method — it is startStream, the event listeners, and cancelStream reassembled into the same shape the platform SDKs return from stream().

addListener(eventName, listenerFunc): Promise<PluginListenerHandle>

"indeRunStreamEvent"

(notification) => void

Promise<PluginListenerHandle>

IndeRunCapacitorPlugin.addListener

addListener(eventName, listenerFunc): Promise<PluginListenerHandle>

"indeRunStreamError"

(notification) => void

Promise<PluginListenerHandle>

IndeRunCapacitorPlugin.addListener


cancelStream(options): Promise<void>

CancelStreamOptions

Promise<void>

IndeRunCapacitorPlugin.cancelStream


checkCapabilities(): Promise<ProviderCapabilitySnapshot[]>

The plugin’s { providers } envelope, unwrapped to match the platform SDKs.

Promise<ProviderCapabilitySnapshot[]>


configure(options?): Promise<void>

ConfigureOptions

Promise<void>

IndeRunCapacitorPlugin.configure


removeAllListeners(): Promise<void>

Promise<void>

IndeRunCapacitorPlugin.removeAllListeners


run(request): Promise<TaskResult>

TaskRequest

Promise<TaskResult>

IndeRunCapacitorPlugin.run


startStream(options): Promise<StreamRunHandle>

Unlike run(request), which passes the request at the options root, this nests it under request so the envelope can also carry streamId. Both native decode sites carry a matching comment.

StartStreamOptions

Promise<StreamRunHandle>

IndeRunCapacitorPlugin.startStream


stream(request): Promise<StreamRun>

TaskRequest

Promise<StreamRun>