Extends
Members
Methods
# async finalize(userID, code) → {Promise.<void>}
Validates the passcode obtained from the email.
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
string
|
The UUID of the user. |
code |
string
|
The passcode digests. |
- See:
Promise.<void>
# getResendAfter(userID) → {number}
Returns the number of seconds the rate limiting is active for.
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
string
|
The UUID of the user. |
number
# getTTL(userID) → {number}
Returns the number of seconds the current passcode is active for.
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
string
|
The UUID of the user. |
number
# async initialize(userID, emailIDopt, forceopt) → {Promise.<Passcode>}
Causes the API to send a new passcode to the user's email address.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userID |
string
|
The UUID of the user. | |
emailID |
string
|
<optional> |
The UUID of the email address. If unspecified, the email will be sent to the primary email address. |
force |
boolean
|
<optional> |
Indicates the passcode should be sent, even if there is another active passcode. |
- See:
Promise.<Passcode>