Class UserLogin

Hierarchy

ResponseObject<ServerUserLoginResponse>
- UserLogin

Implements

Refreshable

Index

Accessors

Methods

Accessors

code

get code(): number

Inherited from ResponseObject.code
- Defined in src/utils/index.ts:68
Returns number

image

get image(): undefined | Base64Image

- Defined in src/user/login.ts:49
Returns undefined | Base64Image

loginSuccess

get loginSuccess(): boolean

- Defined in src/user/login.ts:41
Returns boolean

message

get message(): undefined | string

Inherited from ResponseObject.message
- Defined in src/utils/index.ts:76
Returns undefined | string

mode

get mode(): undefined | string

- Defined in src/user/login.ts:45
Returns undefined | string

raw

get raw(): undefined | (T extends ServerResponse<P, any> ? P : never)

Inherited from ResponseObject.raw
- Defined in src/utils/index.ts:80
Returns undefined | (T extends ServerResponse<P, any> ? P : never)

rawData

get rawData(): any

Inherited from ResponseObject.rawData
- Defined in src/utils/index.ts:84
Returns any

success

get success(): boolean

Inherited from ResponseObject.success
- Defined in src/utils/index.ts:72
Returns boolean

Methods

refresh

refresh(mode?: LoginMode): Promise<UserLogin>

Implementation of Refreshable.refresh
- Defined in src/user/login.ts:53
Parameters
- Optional mode: LoginMode
Returns Promise<UserLogin>

toJSON

toJSON(): any

Inherited from ResponseObject.toJSON
- Defined in src/utils/index.ts:88
Returns any

waitToLogon

waitToLogon(refresh_fn?: (login: UserLogin) => Promise<void>, poll_fn?: (login: UserLogin) => Promise<void>, refresh_ms?: number, ms?: number): Promise<UserLogin>

- Defined in src/user/login.ts:57
Parameters
- Optional refresh_fn: (login: UserLogin) => Promise<void>
  - - (login: UserLogin): Promise<void>
    - Parameters
      - login: UserLogin
      Returns Promise<void>
- Optional poll_fn: (login: UserLogin) => Promise<void>
  - - (login: UserLogin): Promise<void>
    - Parameters
      - login: UserLogin
      Returns Promise<void>
- refresh_ms: number = 1500
- ms: number = 2500
Returns Promise<UserLogin>

Generated using TypeDoc