Class

PasswordClient

PasswordClient()

A class to handle passwords.
Constructor

# new PasswordClient()

View Source lib/client/PasswordClient.ts, line 13

Extends

Members

HttpClient

# protected client

Overrides:

View Source lib/client/Client.ts, line 20

Methods

# getRetryAfter(userID) → {number}

Returns the number of seconds the rate limiting is active for.
Parameters:
Name Type Description
userID string The UUID of the user.

View Source lib/client/PasswordClient.ts, line 135

number

# login(userID, password) → {Promise.<void>}

Logs in a user with a password.
Parameters:
Name Type Description
userID string The UUID of the user.
password string The password.
See:

View Source lib/client/PasswordClient.ts, line 114

Promise.<void>

# update(userID, password) → {Promise.<void>}

Updates a password.
Parameters:
Name Type Description
userID string The UUID of the user.
password string The new password.
See:

View Source lib/client/PasswordClient.ts, line 127

Promise.<void>