@auth0/auth0-acul-react - v1.9.0
    Preparing search index...

    Interface DeviceCodeActivationMembers

    Interface describing the members of the Device Code Activation screen.

    interface DeviceCodeActivationMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        screen: ScreenMembers;
        tenant: TenantMembers;
        transaction: TransactionMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        continue(payload: DeviceCodeActivationContinueOptions): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding client countryCodes? experiment? organization prompt screen tenant transaction user untrustedData

    Methods

    getErrors changeLanguage continue

    Properties

    branding: BrandingMembers
    client: ClientMembers
    countryCodes?: CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: OrganizationMembers
    prompt: PromptMembers
    screen: ScreenMembers
    tenant: TenantMembers
    transaction: TransactionMembers
    user: UserMembers
    untrustedData: UntrustedDataMembers

    Methods

    • Returns Error[]

    • Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form.

      Parameters

      • payload: DeviceCodeActivationContinueOptions

        An object containing the code entered by the user and any custom payload.

        payload for continuing device code activation.

        This interface extends CustomOptions, meaning all custom option properties are merged into the top level of the object. This avoids nesting and provides a simpler structure for consumers of this interface.

        • [key: string]: string | number | boolean | undefined
        • code: string

      Returns Promise<void>

      A promise that resolves when the code is successfully submitted. Rejects with an error if the submission fails.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods