Class default

admin is the only object that unlogged-in clients can access. It holds any methods that are needed to log in.

Hierarchy

default
- default

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

login loginWithSessionCookie redirectInfo

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
Overrides default.constructor
- Defined in api/custom-facades/AdminV4.ts:26

Properties

NAME

NAME: string = "Admin"

VERSION

VERSION: number = 4

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Admin"

`Static` VERSION

VERSION: number = 4

Methods

login

login(params: LoginRequest): Promise<LoginResult>
Parameters
- params: LoginRequest
Returns Promise<LoginResult>
Inherited from default.login
- Defined in api/facades/admin/AdminV3.ts:108

loginWithSessionCookie

loginWithSessionCookie(): Promise<LoginResult>
LoginWithSessionCookie logs in if the session cookie exists when the websocket connection is made. All subsequent requests on the connection will act as the authenticated user.

Returns Promise<LoginResult>
- Defined in api/custom-facades/AdminV4.ts:34

redirectInfo

redirectInfo(params: any): Promise<RedirectInfoResult>
Parameters
- params: any
Returns Promise<RedirectInfoResult>
Inherited from default.redirectInfo
- Defined in api/facades/admin/AdminV3.ts:121

Generated using TypeDoc