Class: default
client/lib/ChatManager/ChatManager.default
Table of contents
Constructors
Properties
Methods
- addUsersToConversation
- getConversation
- getConversationMessages
- getConversations
- getLatestMessagesInConversations
- getSettings
- getUnreadConversationsCount
- getUnreadMessagesInConversations
- markConversationsRead
- markMessageRead
- removeUserFromConversation
- renameGroupConversation
- resetConversationUniverse
- sendGameLinkMessage
- sendMessage
- setConversationUniverse
- startCloudEditConversation
- startGroupConversation
- startOneToOneConversation
- updateTypingStatus
Constructors
constructor
+ new default(client
: default): default
Parameters:
Name | Type |
---|---|
client |
default |
Returns: default
Defined in: client/lib/ChatManager/ChatManager.ts:22
Properties
client
• client: default
Defined in: client/lib/ChatManager/ChatManager.ts:22
Methods
addUsersToConversation
▸ addUsersToConversation(conversation
: number, users
: number[]): Promise<AddUsersToConversation>
Parameters:
Name | Type |
---|---|
conversation |
number |
users |
number[] |
Returns: Promise<AddUsersToConversation>
Defined in: client/lib/ChatManager/ChatManager.ts:58
getConversation
▸ getConversation(conversationId
: number): Promise<null | ChatConversation>
Parameters:
Name | Type |
---|---|
conversationId |
number |
Returns: Promise<null | ChatConversation>
Defined in: client/lib/ChatManager/ChatManager.ts:32
getConversationMessages
▸ getConversationMessages(conversationId
: number, amount?
: number, startMessageId?
: string): Promise<ChatMessage[]>
Parameters:
Name | Type | Default value |
---|---|---|
conversationId |
number | - |
amount |
number | 100 |
startMessageId? |
string | - |
Returns: Promise<ChatMessage[]>
Defined in: client/lib/ChatManager/ChatManager.ts:37
getConversations
▸ getConversations(conversations
: number[]): Promise<ChatConversation[]>
Parameters:
Name | Type |
---|---|
conversations |
number[] |
Returns: Promise<ChatConversation[]>
Defined in: client/lib/ChatManager/ChatManager.ts:51
getLatestMessagesInConversations
▸ getLatestMessagesInConversations(conversations
: number[], amount?
: number): Promise<ChatMessage[]>
Parameters:
Name | Type | Default value |
---|---|---|
conversations |
number[] | - |
amount |
number | 100 |
Returns: Promise<ChatMessage[]>
Defined in: client/lib/ChatManager/ChatManager.ts:104
getSettings
▸ getSettings(): Promise<GetChatSettings>
Returns: Promise<GetChatSettings>
Defined in: client/lib/ChatManager/ChatManager.ts:28
getUnreadConversationsCount
▸ getUnreadConversationsCount(): Promise<number>
Returns: Promise<number>
Defined in: client/lib/ChatManager/ChatManager.ts:46
getUnreadMessagesInConversations
▸ getUnreadMessagesInConversations(conversations
: number[], amount?
: number): Promise<ChatMessage[]>
Parameters:
Name | Type | Default value |
---|---|---|
conversations |
number[] | - |
amount |
number | 100 |
Returns: Promise<ChatMessage[]>
Defined in: client/lib/ChatManager/ChatManager.ts:92
markConversationsRead
▸ markConversationsRead(conversations
: number[]): Promise<MarkConversationsAsSeen>
Parameters:
Name | Type |
---|---|
conversations |
number[] |
Returns: Promise<MarkConversationsAsSeen>
Defined in: client/lib/ChatManager/ChatManager.ts:72
markMessageRead
▸ markMessageRead(conversation
: number, id
: string): Promise<MarkMessageInConversationAsRead>
Parameters:
Name | Type |
---|---|
conversation |
number |
id |
string |
Returns: Promise<MarkMessageInConversationAsRead>
Defined in: client/lib/ChatManager/ChatManager.ts:65
removeUserFromConversation
▸ removeUserFromConversation(conversation
: number, user
: number): Promise<RemoveUserFromConversation>
Parameters:
Name | Type |
---|---|
conversation |
number |
user |
number |
Returns: Promise<RemoveUserFromConversation>
Defined in: client/lib/ChatManager/ChatManager.ts:78
renameGroupConversation
▸ renameGroupConversation(conversation
: number, name
: string): Promise<RenameGroupConversation>
Parameters:
Name | Type |
---|---|
conversation |
number |
name |
string |
Returns: Promise<RenameGroupConversation>
Defined in: client/lib/ChatManager/ChatManager.ts:85
resetConversationUniverse
▸ resetConversationUniverse(conversation
: number): Promise<ResetConversationUniverse>
Parameters:
Name | Type |
---|---|
conversation |
number |
Returns: Promise<ResetConversationUniverse>
Defined in: client/lib/ChatManager/ChatManager.ts:116
sendGameLinkMessage
▸ sendGameLinkMessage(options
: SendGameLinkMessageOptions): Promise<ChatMessageSent>
Parameters:
Name | Type |
---|---|
options |
SendGameLinkMessageOptions |
Returns: Promise<ChatMessageSent>
Defined in: client/lib/ChatManager/ChatManager.ts:122
sendMessage
▸ sendMessage(options
: SendMessageOptions): Promise<ChatMessageSent>
Parameters:
Name | Type |
---|---|
options |
SendMessageOptions |
Returns: Promise<ChatMessageSent>
Defined in: client/lib/ChatManager/ChatManager.ts:127
setConversationUniverse
▸ setConversationUniverse(conversation
: number, universe
: number): Promise<SetConversationUniverse>
Parameters:
Name | Type |
---|---|
conversation |
number |
universe |
number |
Returns: Promise<SetConversationUniverse>
Defined in: client/lib/ChatManager/ChatManager.ts:132
startCloudEditConversation
▸ startCloudEditConversation(placeId
: number): Promise<StartCloudEditConversation>
Parameters:
Name | Type |
---|---|
placeId |
number |
Returns: Promise<StartCloudEditConversation>
Defined in: client/lib/ChatManager/ChatManager.ts:139
startGroupConversation
▸ startGroupConversation(title
: string, users
: number[]): Promise<StartCloudEditConversation>
Parameters:
Name | Type |
---|---|
title |
string |
users |
number[] |
Returns: Promise<StartCloudEditConversation>
Defined in: client/lib/ChatManager/ChatManager.ts:145
startOneToOneConversation
▸ startOneToOneConversation(userId
: number): Promise<StartCloudEditConversation>
Parameters:
Name | Type |
---|---|
userId |
number |
Returns: Promise<StartCloudEditConversation>
Defined in: client/lib/ChatManager/ChatManager.ts:152
updateTypingStatus
▸ updateTypingStatus(conversation
: number, isTyping?
: boolean): Promise<UpdateUserTypingStatus>
Parameters:
Name | Type | Default value |
---|---|---|
conversation |
number | - |
isTyping |
boolean | true |
Returns: Promise<UpdateUserTypingStatus>
Defined in: client/lib/ChatManager/ChatManager.ts:158