Class: Socket
client/lib/ClientSocket/ClientSocket.Socket
Hierarchy
- EventEmitter
↳ Socket
Table of contents
Constructors
Properties
Methods
Constructors
constructor
+ new Socket(client
: default): Socket
Parameters:
Name | Type |
---|---|
client |
default |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:43
Properties
client
• client: default
Defined in: client/lib/ClientSocket/ClientSocket.ts:41
connected
• connected: boolean
Defined in: client/lib/ClientSocket/ClientSocket.ts:43
socket
• socket: any
Defined in: client/lib/ClientSocket/ClientSocket.ts:42
Methods
connect
▸ connect(): Promise<void>
Returns: Promise<void>
Defined in: client/lib/ClientSocket/ClientSocket.ts:53
init
▸ init(): void
This is called after the connection of the socket has successfully been established
Returns: void
Defined in: client/lib/ClientSocket/ClientSocket.ts:93
on
▸ on(event
: chatMessageSent, listener
: (data
: { conversation
: PartialChatConversation }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatMessageSent |
listener |
(data : { conversation : PartialChatConversation }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:12
▸ on(event
: chatUserTyping, listener
: (data
: { conversation
: PartialChatConversation ; user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatUserTyping |
listener |
(data : { conversation : PartialChatConversation ; user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:14
▸ on(event
: chatUserTypingStopped, listener
: (data
: { conversation
: PartialChatConversation ; user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatUserTypingStopped |
listener |
(data : { conversation : PartialChatConversation ; user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:16
▸ on(event
: chatMessage, listener
: (data
: { conversation
: PartialChatConversation ; user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatMessage |
listener |
(data : { conversation : PartialChatConversation ; user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:18
▸ on(event
: chatMessageSent, listener
: (data
: { conversation
: PartialChatConversation ; user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatMessageSent |
listener |
(data : { conversation : PartialChatConversation ; user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:20
▸ on(event
: chatConversationAdded, listener
: (data
: { conversation
: PartialChatConversation }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatConversationAdded |
listener |
(data : { conversation : PartialChatConversation }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:22
▸ on(event
: chatConversationRemoved, listener
: (data
: { conversation
: PartialChatConversation }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatConversationRemoved |
listener |
(data : { conversation : PartialChatConversation }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:24
▸ on(event
: chatMemberAdded, listener
: (data
: { conversation
: PartialChatConversation }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatMemberAdded |
listener |
(data : { conversation : PartialChatConversation }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:26
▸ on(event
: chatMemberLeft, listener
: (data
: { conversation
: PartialChatConversation }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
chatMemberLeft |
listener |
(data : { conversation : PartialChatConversation }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:28
▸ on(event
: friendLost, listener
: (data
: { user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
friendLost |
listener |
(data : { user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:30
▸ on(event
: friendRequest, listener
: (data
: { user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
friendRequest |
listener |
(data : { user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:32
▸ on(event
: friendAdded, listener
: (data
: { user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
friendAdded |
listener |
(data : { user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:34
▸ on(event
: userPresenceChanged, listener
: (data
: { user
: PartialUser }) => void): Socket
Parameters:
Name | Type |
---|---|
event |
userPresenceChanged |
listener |
(data : { user : PartialUser }) => void |
Returns: Socket
Defined in: client/lib/ClientSocket/ClientSocket.ts:36