Skip to content

Module: client/apis/ChatAPI

Table of contents

Classes

Type aliases

Type aliases

AddUsersToConversation

Ƭ AddUsersToConversation: object

Type declaration:

Name Type
conversationId number
rejectedParticipants { displayName: string ; name: string ; rejectedReason: string ; targetId: number ; type: User | string }[]
resultType Success | string
statusMessage string

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

AddUsersToConversationOptions

Ƭ AddUsersToConversationOptions: object

Type declaration:

Name Type
conversationId number
participantUserIds number[]

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

GetChatSettings

Ƭ GetChatSettings: object

Type declaration:

Name Type
chatEnabled boolean

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

GetConversationMessages

Ƭ GetConversationMessages: ChatMessageOptions[]

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

GetConversationMessagesOptions

Ƭ GetConversationMessagesOptions: object

Type declaration:

Name Type
conversationId number
exclusiveStartMessageId? string
pageSize number

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

GetConversations

Ƭ GetConversations: ChatConversationOptions[]

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

GetConversationsOptions

Ƭ GetConversationsOptions: object

Type declaration:

Name Type
conversationIds number[]

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

GetMetaData

Ƭ GetMetaData: object

Type declaration:

Name Type
cachedDataFromLocalStorageExpirationMS number
chatDataFromLocalStorageExpirationSeconds number
isAliasChatForClientSideEnabled boolean
isChatDataFromLocalStorageEnabled boolean
isChatEnabledByPrivacySetting string
isInvalidMessageTypeFallbackEnabled boolean
isPlayTogetherForGameCardsEnabled boolean
isRespectingMessageTypeEnabled boolean
isRoactChatEnabled boolean
isUsingCacheToLoadFriendsInfoEnabled boolean
isVoiceChatForClientSideEnabled boolean
languageForPrivacySettingUnavailable string
maxConversationTitleLength number
numberOfMembersForPartyChrome number
partyChromeDisplayTimeStampInterval number
relativeValueToRecordUiPerformance number
senderTypesForUnknownMessageTypeError string[]
shouldRespectConversationHasUnreadMessageToMarkAsRead boolean
signalRDisconnectionResponseInMilliseconds number
typingInChatForReceiverExpirationMs number
typingInChatFromSenderThrottleMs number
validMessageTypesWhiteList string[]

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

GetMultiLatestConversationMessages

Ƭ GetMultiLatestConversationMessages: GetUnreadMessagesInConversations

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

GetMultiLatestConversationMessagesOptions

Ƭ GetMultiLatestConversationMessagesOptions: object

Type declaration:

Name Type
conversationIds number[]
pageSize number

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

GetRolloutSettings

Ƭ GetRolloutSettings: object

Type declaration:

Name Type
rolloutFeatures { featureName: string ; isRolloutEnabled: boolean }[]

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

GetRolloutSettingsOptions

Ƭ GetRolloutSettingsOptions: object

Type declaration:

Name Type
featureNames string[]

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

GetUnreadConversationCount

Ƭ GetUnreadConversationCount: object

Type declaration:

Name Type
count number

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

GetUnreadMessagesInConversations

Ƭ GetUnreadMessagesInConversations: { chatMessages: ChatMessageOptions[] ; conversationId: number }[]

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

GetUnreadMessagesInConversationsOptions

Ƭ GetUnreadMessagesInConversationsOptions: object

Type declaration:

Name Type
conversationIds number[]
pageSize? number

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

GetUserConversations

Ƭ GetUserConversations: ChatConversationOptions[]

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

GetUserConversationsOptions

Ƭ GetUserConversationsOptions: object

Type declaration:

Name Type
pageNumber number
pageSize number

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

MarkConversationsAsSeen

Ƭ MarkConversationsAsSeen: object

Type declaration:

Name Type
resultType Success | string

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

MarkConversationsAsSeenOptions

Ƭ MarkConversationsAsSeenOptions: object

Type declaration:

Name Type
conversationsToMarkSeen number[]

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

MarkMessageInConversationAsRead

Ƭ MarkMessageInConversationAsRead: object

Type declaration:

Name Type
resultType Success | string

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

MarkMessageInConversationAsReadOptions

Ƭ MarkMessageInConversationAsReadOptions: object

Type declaration:

Name Type
conversationId number
endMessageId string

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

RemoveUserFromConversation

Ƭ RemoveUserFromConversation: object

Type declaration:

Name Type
conversation PartialChatConversationOptions
resultType Success | string
statusMessage string

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

RemoveUserFromConversationOptions

Ƭ RemoveUserFromConversationOptions: object

Type declaration:

Name Type
conversationId number
participantUserId number

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

RenameGroupConversation

Ƭ RenameGroupConversation: object

Type declaration:

Name Type
conversationTitle string
resultType Success | string
statusMessage string
title object
title.isDefaultTitle boolean
title.titleForViewer string

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

RenameGroupConversationOptions

Ƭ RenameGroupConversationOptions: object

Type declaration:

Name Type
conversationId number
newTitle string

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

ResetConversationUniverse

Ƭ ResetConversationUniverse: object

Type declaration:

Name Type
statusMessage string

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

ResetConversationUniverseOptions

Ƭ ResetConversationUniverseOptions: object

Type declaration:

Name Type
conversationId number

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

SendGameLinkMessage

Ƭ SendGameLinkMessage: ChatMessageSentOptions

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

SendGameLinkMessageOptions

Ƭ SendGameLinkMessageOptions: object

Type declaration:

Name Type
conversationId number
decorators string[]
universeId number

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

SendMessage

Ƭ SendMessage: ChatMessageSentOptions

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

SendMessageOptions

Ƭ SendMessageOptions: object

Type declaration:

Name Type
conversationId number
decorators string[]
message string

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

SetConversationUniverse

Ƭ SetConversationUniverse: object

Type declaration:

Name Type
statusMessage string

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

SetConversationUniverseOptions

Ƭ SetConversationUniverseOptions: object

Type declaration:

Name Type
conversationId number
universeId number

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

StartCloudEditConversation

Ƭ StartCloudEditConversation: object

Type declaration:

Name Type
conversation ChatConversationOptions
rejectedParticipants { displayName: string ; name: string ; rejectedReason: string ; targetId: number ; type: User }[]
resultType Success | string
statusMessage string

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

StartCloudEditConversationOptions

Ƭ StartCloudEditConversationOptions: object

Type declaration:

Name Type
placeId number

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

StartGroupConversation

Ƭ StartGroupConversation: StartCloudEditConversation

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

StartGroupConversationOptions

Ƭ StartGroupConversationOptions: object

Type declaration:

Name Type
participantUserIds number[]
title string

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

StartOneToOneConversation

Ƭ StartOneToOneConversation: StartCloudEditConversation

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

StartOneToOneConversationOptions

Ƭ StartOneToOneConversationOptions: object

Type declaration:

Name Type
participantUserId number

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

UpdateUserTypingStatus

Ƭ UpdateUserTypingStatus: object

Type declaration:

Name Type
statusMessage string

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

UpdateUserTypingStatusOptions

Ƭ UpdateUserTypingStatusOptions: object

Type declaration:

Name Type
conversationId number
isTyping boolean

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