EmailTransaction.md

@okta/okta-auth-js/myaccount / Exports / EmailTransaction

Class: EmailTransaction

Hierarchy

• BaseTransaction

  ↳ EmailTransaction

Table of contents

Constructors

• constructor

Properties

• challenge
• delete
• get
• headers
• id
• poll
• profile
• roles
• status
• verify

Constructors

constructor

• new EmailTransaction(oktaAuth, options)

Parameters

Name	Type
oktaAuth	any
options	any

Overrides

BaseTransaction.constructor

Defined in

myaccount/transactions/EmailTransaction.ts:19

Properties

challenge

• challenge: () => Promise<EmailChallengeTransaction>

Type declaration

▸ (): Promise<EmailChallengeTransaction>

Returns

Promise<EmailChallengeTransaction>

Defined in

myaccount/transactions/EmailTransaction.ts:15

---

delete

• delete: () => Promise<BaseTransaction>

Type declaration

▸ (): Promise<BaseTransaction>

Returns

Promise<BaseTransaction>

Defined in

myaccount/transactions/EmailTransaction.ts:14

---

get

• get: () => Promise<EmailTransaction>

Type declaration

▸ (): Promise<EmailTransaction>

Returns

Promise<EmailTransaction>

Defined in

myaccount/transactions/EmailTransaction.ts:13

---

headers

• Optional headers: Record<string, string>

Inherited from

BaseTransaction.headers

Defined in

myaccount/transactions/Base.ts:15

---

id

• id: string

Defined in

myaccount/transactions/EmailTransaction.ts:7

---

poll

• Optional poll: () => Promise<EmailStatusTransaction>

Type declaration

▸ (): Promise<EmailStatusTransaction>

Returns

Promise<EmailStatusTransaction>

Defined in

myaccount/transactions/EmailTransaction.ts:16

---

profile

• profile: EmailProfile

Defined in

myaccount/transactions/EmailTransaction.ts:8

---

roles

• roles: EmailRole[]

Defined in

myaccount/transactions/EmailTransaction.ts:9

---

status

• status: Status

Defined in

myaccount/transactions/EmailTransaction.ts:10

---

verify

• Optional verify: (payload: VerificationPayload) => Promise<BaseTransaction>

Type declaration

▸ (payload): Promise<BaseTransaction>

Parameters

Name	Type
payload	VerificationPayload

Returns

Promise<BaseTransaction>

Defined in

myaccount/transactions/EmailTransaction.ts:17