Class DeviceCodeConfirmation

Class implementing the Device Code Confirmation screen functionality. This screen is displayed when the user needs to confirm the device code.

Hierarchy

BaseContext
- DeviceCodeConfirmation

Implements

Classes.DeviceCodeConfirmationMembers

Index

Constructors

Properties

branding client organization prompt screen tenant transaction untrustedData user screenIdentifier

Methods

cancel confirm getError

Constructors

constructor

new DeviceCodeConfirmation(): DeviceCodeConfirmation
Creates an instance of the DeviceCodeConfirmation screen.

Returns DeviceCodeConfirmation
Overrides BaseContext.constructor
- Defined in src/screens/device-code-confirmation/index.ts:26

Properties

branding

branding: Classes.BrandingMembers

client

client: Classes.ClientMembers

organization

organization: Classes.OrganizationMembers

prompt

prompt: Classes.PromptMembers

screen

screen: Classes.ScreenMembersOnDeviceCodeConfirmation

tenant

tenant: Classes.TenantMembers

transaction

transaction: Classes.TransactionMembers

untrustedData

untrustedData: Classes.UntrustedDataMembers

user

user: Classes.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.DEVICE_CODE_CONFIRMATION

Methods

cancel

cancel(payload?: Classes.CustomOptions): Promise<void>
Cancels the device code flow.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
Example
```
import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';

const deviceCodeConfirmation = new DeviceCodeConfirmation();
await deviceCodeConfirmation.cancel();
```
Implementation of DeviceCodeConfirmationMembers.cancel
- Defined in src/screens/device-code-confirmation/index.ts:62

confirm

confirm(payload?: Classes.CustomOptions): Promise<void>
Confirms the device code.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
Example
```
import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';

const deviceCodeConfirmation = new DeviceCodeConfirmation();
await deviceCodeConfirmation.confirm();
```
Implementation of DeviceCodeConfirmationMembers.confirm
- Defined in src/screens/device-code-confirmation/index.ts:43

getError

getError(): Classes.Error[]
Retrieves the array of transaction errors from the context, or an empty array if none exist.

Returns Classes.Error[]
An array of error objects from the transaction context.
Inherited from BaseContext.getError
- Defined in src/models/base-context.ts:99