@ipscape/chat-client-js/README.md

ipSCAPE chat client SDK

# ipSCAPE - chat-client-js #

This README would normally document whatever steps are necessary to get your application up and running.

### Installation ###

#### npm ####
```shell
npm install @ipscape/chat-client-js 
```

#### yarn ####
```shell
yarn add @ipscape/chat-client-js 
```

### Usage ###



### Methods ###

#### sendMessage ####
```
sendMessage(payload: {
    threadId: string;
    message: string;
    metadata: Record<string, any>;
    senderDisplayName: string;
})
```

#### sendTypingNotification ####
```
sendTypingNotification(payload: {
    threadId: string;
    senderDisplayName: string;
})
```

#### sendReadReceipt ####
```
sendReadReceipt(payload: {
    threadId: string;
    messageId: string;
})
```

#### startRealtimeNotifications ####
```
startRealtimeNotifications()
```

#### stopRealtimeNotifications ####
```
stopRealtimeNotifications()
```