Class AutogramRoot

Hierarchy-Diagram

UML class diagram of AutogramRoot
Legend
icon for a class in the UML class diagram class
icon for a public method in the UML class diagram public method
underlined static property/method

Hierarchy

  • LitElement
    • AutogramRoot

Other

constructor abortController choiceResult desktopSigningState errorMessage hideTimeout mobilePairingUrl mobileSigningUrl onRetryMobileNotification onWaitForPairing pairedDevices screen styles _closeChoiceScreen _closeNow _closeSigningScreen _handleChoice _handlePairingStep _handleRestorePointChoice _handleRetryMobileNotification desktopSigning hide maybeRestoreRestorePoint openMobileOnMobile pairingCompleted reset show showError showQRCode signingCancelled startSigning suggestPairing updateDesktopSigningState

lifecycle

connectedCallback disconnectedCallback

rendering

render

Other

constructor

abortController

abortController: null | AbortController = null

choiceResult

choiceResult:
    | null
    | {
        promise: Promise<SigningMethod>;
        reject: (reason?: unknown) => void;
        resolve: (value: SigningMethod) => void;
    } = null

desktopSigningState

desktopSigningState: DesktopSigningState

errorMessage

errorMessage: null | string = null

hideTimeout

hideTimeout: null | Timeout = null

mobilePairingUrl

mobilePairingUrl: null | string

mobileSigningUrl

mobileSigningUrl: null | string

onRetryMobileNotification

onRetryMobileNotification: null | () => Promise<void> = null

onWaitForPairing

onWaitForPairing:
    | null
    | (
        signal: AbortSignal,
        onPairingUrl: (pairingUrl: string) => void,
    ) => Promise<
        null
        | { deviceId: string; displayName: string; platform: string }[],
    > = null

Polls for a new pairing; resolves the devices, null on abort/timeout.

pairedDevices

pairedDevices:
    | null
    | { deviceId: string; displayName: string; platform: string }[]

screen

screen: Screens

Staticstyles

styles: CSSResult[] = ...

Styles for the component

_closeChoiceScreen

_closeNow

_closeSigningScreen

_handleChoice

_handlePairingStep

_handleRestorePointChoice

_handleRetryMobileNotification

  • _handleRetryMobileNotification(
        _event: EventRetryMobileNotification,
    ): Promise<void>

    Parameters

    • _event: EventRetryMobileNotification

    Returns Promise<void>

desktopSigning

hide

maybeRestoreRestorePoint

openMobileOnMobile

pairingCompleted

  • pairingCompleted(
        devices: { deviceId: string; displayName: string; platform: string }[],
    ): void

    Parameters

    • devices: { deviceId: string; displayName: string; platform: string }[]

    Returns void

reset

show

showError

showQRCode

  • showQRCode(
        url: string,
        pairingUrl: null | string,
        abortController: AbortController,
    ): void

    Parameters

    • url: string
    • pairingUrl: null | string

      null hides the pairing link

    • abortController: AbortController

    Returns void

signingCancelled

startSigning

suggestPairing

  • suggestPairing(pairingUrl: string, abortController: AbortController): void

    Suggest pairing after a mobile signature. Called again with a fresh URL before the pairing JWT expires; closing aborts abortController.

    Parameters

    • pairingUrl: string
    • abortController: AbortController

    Returns void

updateDesktopSigningState

lifecycle

connectedCallback

  • connectedCallback(): void

    Invoked when the component is added to the document's DOM.

    In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

    connectedCallback() {
      super.connectedCallback();
      addEventListener('keydown', this._handleKeydown);
    }

    Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

    Returns void

disconnectedCallback

  • disconnectedCallback(): void

    Invoked when the component is removed from the document's DOM.

    This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

    disconnectedCallback() {
      super.disconnectedCallback();
      window.removeEventListener('keydown', this._handleKeydown);
    }

    An element may be re-connected after being disconnected.

    Returns void

rendering

render

  • render(): TemplateResult<1>

    Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

    Returns TemplateResult<1>

Settings

Member Visibility

On This Page

Other
lifecycle
rendering