Class: default

client/apis/ChatAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• addUsersToConversation
• getChatSettings
• getConversationMessages
• getConversations
• getMetaData
• getMultiLatestConversationMessages
• getRolloutSettings
• getUnreadConversationCount
• getUnreadMessagesInConversations
• getUserConversations
• markConversationMessagesRead
• markConversationsSeen
• removeUserFromConversation
• renameGroupConversation
• request
• resetConversationUniverse
• sendGameLinkMessage
• sendMessage
• setConversationUniverse
• startCloudEditConversation
• startGroupConversation
• startOneToOneConversation
• updateUserTypingStatus

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/ChatAPI.ts:186

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

addUsersToConversation

▸ addUsersToConversation(options: AddUsersToConversationOptions): Promise<AddUsersToConversation>

Parameters:

Name	Type
options	AddUsersToConversationOptions

Returns: Promise<AddUsersToConversation>

Defined in: client/apis/ChatAPI.ts:306

---

getChatSettings

▸ getChatSettings(): Promise<GetChatSettings>

Returns: Promise<GetChatSettings>

Defined in: client/apis/ChatAPI.ts:194

---

getConversationMessages

▸ getConversationMessages(options: GetConversationMessagesOptions): Promise<GetConversationMessages>

Parameters:

Name	Type
options	GetConversationMessagesOptions

Returns: Promise<GetConversationMessages>

Defined in: client/apis/ChatAPI.ts:219

---

getConversations

▸ getConversations(options: GetConversationsOptions): Promise<GetConversations>

Parameters:

Name	Type
options	GetConversationsOptions

Returns: Promise<GetConversations>

Defined in: client/apis/ChatAPI.ts:205

---

getMetaData

▸ getMetaData(): Promise<GetMetaData>

Returns: Promise<GetMetaData>

Defined in: client/apis/ChatAPI.ts:283

---

getMultiLatestConversationMessages

▸ getMultiLatestConversationMessages(options: GetMultiLatestConversationMessagesOptions): Promise<GetUnreadMessagesInConversations>

Parameters:

Name	Type
options	GetMultiLatestConversationMessagesOptions

Returns: Promise<GetUnreadMessagesInConversations>

Defined in: client/apis/ChatAPI.ts:294

---

getRolloutSettings

▸ getRolloutSettings(options: GetRolloutSettingsOptions): Promise<GetRolloutSettings>

Parameters:

Name	Type
options	GetRolloutSettingsOptions

Returns: Promise<GetRolloutSettings>

Defined in: client/apis/ChatAPI.ts:231

---

getUnreadConversationCount

▸ getUnreadConversationCount(): Promise<GetUnreadConversationCount>

Returns: Promise<GetUnreadConversationCount>

Defined in: client/apis/ChatAPI.ts:245

---

getUnreadMessagesInConversations

▸ getUnreadMessagesInConversations(options: GetUnreadMessagesInConversationsOptions): Promise<GetUnreadMessagesInConversations>

Parameters:

Name	Type
options	GetUnreadMessagesInConversationsOptions

Returns: Promise<GetUnreadMessagesInConversations>

Defined in: client/apis/ChatAPI.ts:256

---

getUserConversations

▸ getUserConversations(options: GetUserConversationsOptions): Promise<GetUserConversations>

Parameters:

Name	Type
options	GetUserConversationsOptions

Returns: Promise<GetUserConversations>

Defined in: client/apis/ChatAPI.ts:271

---

markConversationMessagesRead

▸ markConversationMessagesRead(options: MarkMessageInConversationAsReadOptions): Promise<MarkMessageInConversationAsRead>

Parameters:

Name	Type
options	MarkMessageInConversationAsReadOptions

Returns: Promise<MarkMessageInConversationAsRead>

Defined in: client/apis/ChatAPI.ts:319

---

markConversationsSeen

▸ markConversationsSeen(options: MarkConversationsAsSeenOptions): Promise<MarkConversationsAsSeen>

Parameters:

Name	Type
options	MarkConversationsAsSeenOptions

Returns: Promise<MarkConversationsAsSeen>

Defined in: client/apis/ChatAPI.ts:332

---

removeUserFromConversation

▸ removeUserFromConversation(options: RemoveUserFromConversationOptions): Promise<RemoveUserFromConversation>

Parameters:

Name	Type
options	RemoveUserFromConversationOptions

Returns: Promise<RemoveUserFromConversation>

Defined in: client/apis/ChatAPI.ts:345

---

renameGroupConversation

▸ renameGroupConversation(options: RenameGroupConversationOptions): Promise<RenameGroupConversation>

Parameters:

Name	Type
options	RenameGroupConversationOptions

Returns: Promise<RenameGroupConversation>

Defined in: client/apis/ChatAPI.ts:358

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

resetConversationUniverse

▸ resetConversationUniverse(options: ResetConversationUniverseOptions): Promise<ResetConversationUniverse>

Parameters:

Name	Type
options	ResetConversationUniverseOptions

Returns: Promise<ResetConversationUniverse>

Defined in: client/apis/ChatAPI.ts:371

---

sendGameLinkMessage

▸ sendGameLinkMessage(options: SendGameLinkMessageOptions): Promise<ChatMessageSentOptions>

Parameters:

Name	Type
options	SendGameLinkMessageOptions

Returns: Promise<ChatMessageSentOptions>

Defined in: client/apis/ChatAPI.ts:384

---

sendMessage

▸ sendMessage(options: SendMessageOptions): Promise<ChatMessageSentOptions>

Parameters:

Name	Type
options	SendMessageOptions

Returns: Promise<ChatMessageSentOptions>

Defined in: client/apis/ChatAPI.ts:397

---

setConversationUniverse

▸ setConversationUniverse(options: SetConversationUniverseOptions): Promise<SetConversationUniverse>

Parameters:

Name	Type
options	SetConversationUniverseOptions

Returns: Promise<SetConversationUniverse>

Defined in: client/apis/ChatAPI.ts:410

---

startCloudEditConversation

▸ startCloudEditConversation(options: StartCloudEditConversationOptions): Promise<StartCloudEditConversation>

Parameters:

Name	Type
options	StartCloudEditConversationOptions

Returns: Promise<StartCloudEditConversation>

Defined in: client/apis/ChatAPI.ts:423

---

startGroupConversation

▸ startGroupConversation(options: StartGroupConversationOptions): Promise<StartCloudEditConversation>

Parameters:

Name	Type
options	StartGroupConversationOptions

Returns: Promise<StartCloudEditConversation>

Defined in: client/apis/ChatAPI.ts:436

---

startOneToOneConversation

▸ startOneToOneConversation(options: StartOneToOneConversationOptions): Promise<StartCloudEditConversation>

Parameters:

Name	Type
options	StartOneToOneConversationOptions

Returns: Promise<StartCloudEditConversation>

Defined in: client/apis/ChatAPI.ts:449

---

updateUserTypingStatus

▸ updateUserTypingStatus(options: UpdateUserTypingStatusOptions): Promise<UpdateUserTypingStatus>

Parameters:

Name	Type
options	UpdateUserTypingStatusOptions

Returns: Promise<UpdateUserTypingStatus>

Defined in: client/apis/ChatAPI.ts:462