Interface AutogramClientOptions

Options for createAutogramClient.

interface AutogramClientOptions {
    desktopChannel?: AutogramDesktopIntegrationInterface;
    displayName?: string;
    enableNotifications?: boolean;
    mobileChannel?: AutogramVMobileIntegrationInterfaceStateful;
    mobileStorage?: AVMStorage;
    onResetSignRequest?: () => void;
    pairingEnabled?: boolean;
    platform?: string;
}

Properties

desktopChannel? displayName? enableNotifications? mobileChannel? mobileStorage? onResetSignRequest? pairingEnabled? platform?

Properties

OptionaldesktopChannel

desktopChannel?: AutogramDesktopIntegrationInterface

Autogram desktop channel; defaults to direct HTTP calls to the local desktop app.

OptionaldisplayName

displayName?: string

Display name reported when registering the AVM integration.

OptionalenableNotifications

enableNotifications?: boolean

Send push notifications to paired mobile devices. Default true. Applies to the default mobile channel; a custom mobileChannel decides about notifications itself. When false, pairing is never offered with the default channel.

OptionalmobileChannel

mobileChannel?: AutogramVMobileIntegrationInterfaceStateful

Autogram v Mobile channel. Provide one to route AVM calls through a different execution context (e.g. an extension background worker); defaults to direct HTTPS calls to the AVM service.

OptionalmobileStorage

mobileStorage?: AVMStorage

Where the default mobile channel persists the AVM integration identity (key pair + GUID; paired phones are bound to it) and restore points. Default: IndexedDB of the current origin. Ignored with a custom mobileChannel.

OptionalonResetSignRequest

onResetSignRequest?: () => void

Called when the client resets its signing state.

OptionalpairingEnabled

pairingEnabled?: boolean

Offer pairing a phone for notifications: the link on the QR screen and the pairing suggestion after a mobile signature when no phone is paired yet. Default false.

Only takes effect when the mobile channel implements the optional notification methods (getPairingQrCodeUrl, sendNotification, getPairedDevices) — the default channel does; a custom channel that omits them never shows pairing UI.

Optionalplatform

platform?: string

Platform reported when registering the AVM integration.

Settings

Member Visibility

On This Page

Properties