@elizaos/core v1.0.0-beta.7 / IWebSocketService
Interface: IWebSocketService
Interface for WebSocket service implementations
Extends
Methods
connect()
connect():
Promise<void>
Connect to the WebSocket server
Returns
Promise<void>
Defined in
packages/core/src/services/websocket.ts:55
joinRoom()
joinRoom(
roomId):void
Join a room on the WebSocket server
Parameters
• roomId: string
Returns
void
Defined in
packages/core/src/services/websocket.ts:60
sendMessage()
sendMessage(
message):Promise<void>
Send a message to the WebSocket server
Parameters
• message: WebSocketMessage
Returns
Promise<void>
Defined in
packages/core/src/services/websocket.ts:65
sendTextMessage()
sendTextMessage(
options):void
Send a text message to a room
Parameters
• options: WebSocketMessageOptions
Returns
void
Defined in
packages/core/src/services/websocket.ts:70
disconnect()
disconnect():
void
Disconnect from the WebSocket server
Returns
void
Defined in
packages/core/src/services/websocket.ts:75
isConnected()
isConnected():
boolean
Check if connected to the WebSocket server
Returns
boolean
Defined in
packages/core/src/services/websocket.ts:80
onMessage()
onMessage(
handler):void
Register a message handler
Parameters
• handler
Returns
void
Defined in
packages/core/src/services/websocket.ts:85
onTextMessage()
onTextMessage(
handler):void
Register a text message handler
Parameters
• handler
Returns
void