Interface ClientSignOptions

Options of the unified CombinedClient.sign form.

interface ClientSignOptions {
    onState?: DesktopSigningStateConsumer;
    presentation?: {
        visualizationWidth?: null | "sm" | "md" | "lg" | "xl" | "xxl";
    };
    signal?: AbortSignal;
}

Properties

onState? presentation? signal?

Properties

OptionalonState

onState?: DesktopSigningStateConsumer

Desktop launch/signing progress updates.

Optionalpresentation

presentation?: { visualizationWidth?: null | "sm" | "md" | "lg" | "xl" | "xxl" }

How the desktop app presents the documents before signing (Autogram >= 2.8.0; mapped to visualizationWidth for older versions).

Type declaration

  • OptionalvisualizationWidth?: null | "sm" | "md" | "lg" | "xl" | "xxl"

    Description

    Optional width of the signing document visualization. Values are sm (640px), md (768px), lg (1024px), xl (1280px), xxl (1536px). The minimum visualization width is set to 640px. If the preferred visualization width is exceeds width of client's screen, the visualization width is set to the width of the client's screen.

    Default

    sm
    @enum {string}

Optionalsignal

signal?: AbortSignal

Cancels the signing step.

Settings

Member Visibility

On This Page

Properties