ChatUserClient
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:38
Calls the Chat API as the signed-in user, inside one tenant application — the user-facing half
of an embedded Chat integration. The tenant’s backend (with @central-code-station/ccs-chat-client)
decides who may talk to whom and creates those conversations; this client lists them, reads and
sends messages, reacts, marks read, signals typing and reports presence. Live updates come from
@central-code-station/ccs-chat-notifications-client.
Chat checks every call against the user’s permissions in this context and their conversation membership; a token issued to your application’s client works only in your application.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ChatUserClient(
options):ChatUserClient
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:52
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”ChatUserClient
Properties
Section titled “Properties”tenantId
Section titled “tenantId”
readonlytenantId:string
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:39
applicationId
Section titled “applicationId”
readonlyapplicationId:string
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:40
conversations
Section titled “conversations”
readonlyconversations:ConversationsResource
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:41
messages
Section titled “messages”
readonlymessages:MessagesResource
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:42
readonlyusers:UsersResource
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:43
presence
Section titled “presence”
readonlypresence:PresenceResource
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:44
Methods
Section titled “Methods”me():
Promise<ChatUserProfile>
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:83
The signed-in user’s Chat profile (cached for the life of this client).
Returns
Section titled “Returns”Promise<ChatUserProfile>
capabilities()
Section titled “capabilities()”capabilities():
Promise<ChatCapabilities>
Defined in: libs/ccs-chat-user-client/src/chat-user-client.ts:92
The user’s Chat permissions in this tenant application — use them to show or hide controls.
Returns
Section titled “Returns”Promise<ChatCapabilities>