# ChatClientService The `ChatClient` service connects the user to the Stream chat. ## Type parameters | Name | Type | | :--- | :---------------------------------------------------------------- | | `T` | extends `DefaultStreamChatGenerics` = `DefaultStreamChatGenerics` | ## Properties ### appSettings$ • **appSettings$**: `Observable` Emits the current [application settings](/chat/docs/javascript/app_setting_overview/). Since getting the application settings is an expensive API call and we don't always need the result, this is not initialized by default, you need to call `getApplicationSettings` to load them. #### Defined in [lib/chat-client.service.ts:49](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L49) --- ### chatClient • **chatClient**: `StreamChat` The [StreamChat client](https://github.com/GetStream/stream-chat-js/blob/master/src/client.ts) instance. In general you shouldn't need to access the client, but it's there if you want to use it. #### Defined in [lib/chat-client.service.ts:38](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L38) --- ### connectionState$ • **connectionState$**: `Observable<"offline" | "online">` Emits the current connection state of the user (`online` or `offline`) #### Defined in [lib/chat-client.service.ts:53](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L53) --- ### events$ • **events$**: `Observable>` Emits [`ClientEvent`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/chat-client.service.ts) events. The platform documentation covers [the list of client, user presence and notification events](/chat/docs/javascript/event_object/). For performance reasons this Observable operates outside of the Angular change detection zone. If you subscribe to it, you need to manually reenter Angular's change detection zone, our [Change detection guide](/chat/docs/sdk/angular/v4/concepts/change-detection/) explains this in detail. #### Defined in [lib/chat-client.service.ts:45](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L45) --- ### pendingInvites$ • **pendingInvites$**: `Observable<(ChannelResponse | Channel)[]>` Emits the list of pending invites of the user. It emits every pending invitation during initialization and then extends the list when a new invite is received. More information can be found in the [channel invitations](/chat/docs/sdk/angular/v4/code-examples/channel-invites/) guide. #### Defined in [lib/chat-client.service.ts:57](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L57) --- ### user$ • **user$**: `Observable | UserResponse>` Emits the current chat user #### Defined in [lib/chat-client.service.ts:61](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L61) ## Methods ### autocompleteUsers ▸ **autocompleteUsers**(`searchTerm`): `Promise[]>` Searches for users in the application that have ID or name matching the provided search term #### Parameters | Name | Type | | :----------- | :------- | | `searchTerm` | `string` | #### Returns `Promise[]>` The users matching the search #### Defined in [lib/chat-client.service.ts:209](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L209) --- ### disconnectUser ▸ **disconnectUser**(): `Promise` Disconnects the current user, and closes the WebSocket connection. Useful when disconnecting a chat user, use in combination with [`reset`](/chat/docs/sdk/angular/v4/services/ChannelService#reset/). #### Returns `Promise` #### Defined in [lib/chat-client.service.ts:178](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L178) --- ### flagMessage ▸ **flagMessage**(`messageId`): `Promise` Flag the message with the given ID. If you want to know [more about flags](/chat/docs/javascript/moderation/) check out the platform documentation. #### Parameters | Name | Type | | :---------- | :------- | | `messageId` | `string` | #### Returns `Promise` #### Defined in [lib/chat-client.service.ts:200](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L200) --- ### getAppSettings ▸ **getAppSettings**(): `Promise` Loads the current [application settings](/chat/docs/javascript/app_setting_overview/), if the application settings have already been loaded, it does nothing. #### Returns `Promise` #### Defined in [lib/chat-client.service.ts:188](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L188) --- ### init ▸ **init**(`apiKey`, `userOrId`, `userTokenOrProvider`, `clientOptions?`): `ConnectAPIResponse` Creates a [`StreamChat`](https://github.com/GetStream/stream-chat-js/blob/668b3e5521339f4e14fc657834531b4c8bf8176b/src/client.ts#L124) instance using the provided `apiKey`, and connects a user with the given meta data and token. More info about [connecting users](/chat/docs/javascript/init_and_users/) can be found in the platform documentation. #### Parameters | Name | Type | Description | | :-------------------- | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `apiKey` | `string` | | | `userOrId` | `undefined` \| `string` \| `OwnUserResponse` \| `UserResponse` | you can emit this for anonymous logins | | `userTokenOrProvider` | `TokenOrProvider` | You can provide:
  • a token,
  • a token provider, a method that returns `Promise`, which can be called when the previous token expires (recommended setup for production applications)
  • the keyword 'guest' to connect as [guest user](/chat/docs/javascript/authless_users/#guest-users/)
  • the keyword 'anonymous' to connect as [anonymous user](/chat/docs/javascript/authless_users/#anonymous-users/)
| | `clientOptions?` | `StreamChatOptions` | Setting to provide to the Stream client instance | #### Returns `ConnectAPIResponse` #### Defined in [lib/chat-client.service.ts:98](https://github.com/GetStream/stream-chat-angular/blob/2451bc8/projects/stream-chat-angular/src/lib/chat-client.service.ts#L98) --- This page was last updated at 2026-05-13T13:38:37.283Z. For the most recent version of this documentation, visit [https://getstream.io/chat/docs/sdk/angular/v4/services/ChatClientService/](https://getstream.io/chat/docs/sdk/angular/v4/services/ChatClientService/).