[ Web Proxy ]
URL:
Viewing: https://adminforth.dev/docs/api/Back/interfaces/IWebSocketClient/ [Back]  [Original]

IWebSocketClient | Agent-first open-source admin panel framework
Skip to main content
On this page

IWebSocketClient

Properties

adminUser

adminUser: AdminUser


authorize

authorize: () => Promise<AdminUserAuthorizationResult>

Authorizes handshake request of this connection again: verifies its auth jwt and runs adminUserAuthorize hooks, so access which was revoked after connection was established is noticed.

Returns

Promise<AdminUserAuthorizationResult>


clientId?

optional clientId?: string


close

close: () => void

Returns

void


id

id: string


lastPing

lastPing: number


onClose

onClose: (handler) => void

Parameters

ParameterType
handler() => void

Returns

void


onMessage

onMessage: (handler) => void

Parameters

ParameterType
handler(message) => void

Returns

void


send

send: (message) => void

Parameters

ParameterType
messagestring

Returns

void


topics

topics: Set<string>

Previous
IWebSocketBroker
Next
PluginsCommonOptions

Web Proxy Viewer  |  New URL  |  Original Page