vlocode-project - v1.40.0-beta-4
    Preparing search index...

    Interface DeviceLoginFlow

    interface DeviceLoginFlow {
        userCode: string;
        verificationUrl: string;
        verificationUrlWithCode?: string;
        awaitDeviceApproval(
            options?: { openVerificationUrl?: boolean },
            cancelToken?: CancellationToken,
        ): Promise<SalesforceAuthResult>;
    }
    Index

    Properties

    userCode verificationUrl verificationUrlWithCode?

    Methods

    awaitDeviceApproval

    Properties

    userCode: string

    User code to display to the user that must be entered on the device login page (verificationUrl) to approve the login request. The device login page verificationUrl can be opened automatically by setting the openVerificationUrl option to true when calling awaitDeviceApproval.

    verificationUrl: string

    URL to open in the browser to approve the device login request.

    verificationUrlWithCode?: string

    Optional the verification URL with the user code appended as query parameter.

    Methods

    • Await the user to approve the device login request.

      Parameters

      • Optionaloptions: { openVerificationUrl?: boolean }

        Options for the device login flow

        • OptionalopenVerificationUrl?: boolean

          Open the verification URL in the default browser; defaults to true when not specified

      • OptionalcancelToken: CancellationToken

        Cancellation token to cancel the login flow

      Returns Promise<SalesforceAuthResult>

      A promise that resolves when the user has approved the device login request

    Settings

    Member Visibility

    On This Page

    Properties
    Methods