Skip to content
CCS Chat Docs
Search
Ctrl
K
Cancel
Identity Server docs
Select theme
Dark
Light
Auto
Menu
Before you start
The Identity Server comes first
Prerequisite checklist
Glossary
Identity Server docs ↗
Get started
Choose how to use Chat
Standalone Chat in 10 minutes
Integrated Chat, part 1: your backend
Integrated Chat, part 2: your web app
Integrated Chat in Angular
Integrated Chat in React
Use the REST API from any stack
Using the Chat app
Concepts
Architecture at a glance
Tenants and applications
Identity and tokens
Chat permissions
Machine scopes
Conversations
Messages
Realtime
Presence
Push notifications
Pagination
Errors
Security and isolation
Limits
Guides
Identity Server setup
Register a backend client
Grant Chat scopes
Enable token exchange
Register web origins
Permissions
Grant permissions to roles
Permission sets for standalone use
Backend
Create direct conversations
Groups and channels
Send on behalf of a user and SYSTEM messages
Archive and reactivate conversations
Issue Chat tokens to your users
Look up users
Handle errors and retries
Web and mobile apps
Get the user's Chat token
List conversations and read messages
Send, edit, delete and react
Live updates
Typing, read state and presence
Web push
Angular in depth
React in depth
Mobile and React Native
Migrations
Migrate ccs-chat-client 2.x to 3.0.0
Migrate ccs-chat-notifications-client 0.x to 1.0.0
Multi-tenant apps
Other languages
Local development
Troubleshooting
Administration
Administration overview
Switch Chat on for an application
Roles and permissions
Members
Applications
Conversations and moderation
Settings
Audit log
Refresh from the Identity Server
Reference
API conventions
API operations
Overview
Context
Overview
The signed-in user's Chat profile
Chat-enabled tenants the user belongs to
The tenant's applications, with whether each can use Chat
The caller's tenant-level Chat permissions (e.g. administration.*)
The caller's Chat permissions in an application context
Conversations
Overview
List conversations
Create a conversation
Get a conversation
Delete a conversation (soft delete)
Update a conversation
List members
Add a member
Remove a member, or leave
Messages
Overview
List messages
Send a message
Delete a message (tombstone)
Edit a message
Add a reaction
Remove a reaction
Mark read
Signal typing
Users
Overview
Look up tenant members
Presence
Overview
Presence heartbeat
Go offline
Presence of users
Notifications
Overview
Web push VAPID public key
Register a push device
Unregister a push device
Realtime stream credential
Administration
Overview
Tenant overview
The tenant's roles with their Chat capabilities in one context
Replace a role's Chat capabilities in one context
Members known to Chat, with their roles and capabilities
The tenant's applications as Chat stores them
Chat settings
Update Chat settings
Refresh from the Identity Server
Every conversation of the tenant (moderation)
Delete a conversation (moderation)
Remove a member from a conversation (moderation)
Audit log
Realtime events
Push payloads
Errors
Capabilities
Scopes
Limits
Data types
OpenAPI document
SDKs
SDKs overview
ccs-chat-client
ccs-chat-client
ccs-chat-client changelog
API reference
Classes
ChatApiError
ChatClient
ChatForbiddenError
ChatNotFoundError
ChatRateLimitedError
ChatUnauthorizedError
ChatUnprocessableError
Interfaces
AddMemberInput
ChatApiErrorBody
ChatAttachment
ChatClientOptions
ChatConversation
ChatMember
ChatMessage
ChatUserProfile
ChatUserRef
CreateConversationInput
ListConversationsOptions
ListOptions
Page
SendMessageInput
UpdateConversationInput
Type Aliases
ChatMachineScope
ConversationStatus
ConversationType
ConversationVisibility
MessageType
Functions
toChatApiError
ccs-chat-user-client
ccs-chat-user-client
ccs-chat-user-client for Angular
ccs-chat-user-client for React
ccs-chat-user-client changelog
API reference
angular
Interfaces
ChatUserClientRx
Type Aliases
ObservableMethods
Variables
CHAT_USER_CLIENT
Functions
createChatUserClient
provideChatUserClient
toObservableMethods
index
Classes
ChatApiError
ChatForbiddenError
ChatNotFoundError
ChatRateLimitedError
ChatUnauthorizedError
ChatUnprocessableError
ChatUserClient
Interfaces
ChatApiErrorBody
ChatAttachment
ChatCapabilities
ChatConversation
ChatMember
ChatMessage
ChatPresence
ChatUserClientOptions
ChatUserProfile
ChatUserRef
ConversationsResource
CreateConversationInput
ListConversationsOptions
ListOptions
MessagesResource
Page
PresenceResource
SendMessageInput
UpdateConversationInput
UsersResource
Type Aliases
AccessTokenProvider
ChatCapability
ConversationStatus
ConversationType
ConversationVisibility
MessageType
Functions
toChatApiError
react
Classes
ChatPagesStore
ChatRequestStore
Interfaces
ChatPagesState
ChatRequestState
UseChatPagesResult
UseChatRequestOptions
UseChatRequestResult
Functions
ChatUserClientProvider
useCapabilities
useChatPages
useChatRequest
useChatUserClient
useConversations
useMessages
ccs-chat-notifications-client
ccs-chat-notifications-client
ccs-chat-notifications-client for Angular
ccs-chat-notifications-client for React
Web push with ccs-chat-notifications-client
ccs-chat-notifications-client changelog
API reference
angular
Interfaces
ChatNotifications
Functions
createChatNotifications
index
Classes
ChatNotificationsClient
Interfaces
ChatEventSourceLike
ChatMessagePayload
ChatNotificationEventMap
ChatNotificationsClientOptions
ChatUserRef
ContextFields
ConversationChangedEvent
ConversationEventBase
MemberAddedEvent
MemberRemovedEvent
MessageCreatedEvent
MessageDeletedEvent
PresenceUpdatedEvent
ReactionEvent
TypingEvent
Type Aliases
ChatNotificationEventType
ConnectionState
MessageUpdatedEvent
Unsubscribe
push
Classes
ChatPushClient
Interfaces
ChatPushClientOptions
PushRegistrationResult
push/react
Interfaces
UsePushRegistrationResult
Type Aliases
PushRegistrationStatus
Functions
usePushRegistration
react
Interfaces
UseChatNotificationsOptions
UseChatNotificationsResult
Functions
useChatNotificationEvent
useChatNotifications
Resources
Platform changelog
FAQ
Support
Roadmap and limitations
Identity Server docs
Select theme
Dark
Light
Auto
Unsubscribe
Unsubscribe
= () =>
void
Defined in:
core/types.ts:95
Returns
Section titled “Returns”
void