Class AuthFlowKind

The kind of authentication flow to perform. This can either be a sign in or a sign up flow.

Index

Properties

Methods

[dispose] free signin signup

Properties

`Readonly`intent

intent: string

Get the intent of the authentication flow.

Returns

"signin" - If the authentication flow is a sign in flow.
"signup" - If the authentication flow is a sign up flow.

Methods

[dispose]

"[dispose]"(): void
Returns void
- Defined in pubky.d.ts:328

free

free(): void
Returns void
- Defined in pubky.d.ts:327

`Static`signin

signin(): AuthFlowKind
Create a sign in flow.

Returns AuthFlowKind
- Defined in pubky.d.ts:332

`Static`signup

signup(
homeserver_public_key: PublicKey,
signup_token?: string | null,
): AuthFlowKind
Create a sign up flow.

Arguments
- homeserver_public_key - The public key of the homeserver to sign up on.
- signup_token - The signup token to use for the signup flow. This is optional.
Parameters
- homeserver_public_key: PublicKey
- Optionalsignup_token: string | null
Returns AuthFlowKind
- Defined in pubky.d.ts:339