Typescript SDK - Chat API

About 173 wordsLess than 1 minute

Comprehensive code examples for the Stream chat typescript SDK.

Chat (56 methods)
Common (35 methods)
Moderation (12 methods)
Types Reference - interfaces for API requests/responses

Overview

This documentation covers 103 API methods across 3 categories.

Installation

npm install stream-chat
# or
yarn add stream-chat

Basic Setup

import { StreamChat } from "stream-chat";

// Initialize the client
const client = StreamChat.getInstance("YOUR_API_KEY");

// Connect the user
await client.connectUser({ id: "john" }, "USER_TOKEN");

Categories

Chat

queryChannels() - Query channels
deleteChannels() - Deletes channels asynchronously
markDelivered() - Mark channel message delivery status
markChannelsRead() - Mark channels as read
getOrCreateDistinctChannel() - Get or create channel
... and 51 more methods

Common

getApp() - Get App Settings
listBlockLists() - List block lists
createBlockList() - Create block list
updateBlockList() - Update block list
deleteBlockList() - Delete block list
... and 30 more methods

Moderation

appeal() - Appeal against the moderation decision
getAppeal() - Get appeal item
queryAppeals() - Query Appeals
ban() - Ban
upsertConfig() - Create or update moderation configuration
... and 7 more methods

Generated from Stream OpenAPI specification