# Conversation (Chat)
A conversation(chat) object lets you have conversations with 1 or more [Users](/reference/user.md).
You can view how a chat object can be created for a [one-to-one conversation](/javascript-sdk/overview.md#start-one-to-one-conversation) or a [group chat](/javascript-sdk/overview.md#start-group-chat) with multiple members.
## Event Listeners
### Listen for new messages
This is called whenever the current user receives a new message.
```javascript
chat.onMessage((message) => {
//do something with message
})
```
**Response**
| Field | Type | Description |
|---|
message | Message | the message that has been received. |
### Listen for message updated
This is called whenever a message gets updated in the chat.
```javascript
chat.onMessageUpdated((message) => {
//do something with the updated message
})
```
**Response**
| Field | Type | Description |
|---|
message | Message | the message that has been updated. |
### Listen for message deleted
This is called whenever a message gets deleted.
```javascript
chat.onMessageDeleted((messageId) => {
//do something
})
```
**Response**
| Field | Type | Description |
|---|
messageId | String | the id of the message that has been deleted. |
### Listen for typing started
This is called whenever a participant of the conversation starts typing.
```jsx
chat.onTypingStarted((user) => {
//do something when a user starts typing
})
```
**Response**
| Field | Type | Description |
|---|
user | User | the user that started typing |
### Listen for typing stopped
This is called whenever a participant of the conversation stops typing.
```jsx
chat.onTypingStopped((user) => {
//do something when a user stops typing
})
```
**Response**
| Field | Type | Description |
|---|
user | User | the user that stopped typing |
### Listen for message seen events
This is called whenever a message has been seen by a participant in a conversation
```javascript
chat.onMessageSeen((messageId) => {
//do something when a message is seen
})
```
**Response**
| Field | Type | Description |
|---|
messageId | string | the id of the message that has been seen |
### Listen for user status changes (online/offline)
This is called whenever the status of a user in a conversation changes from online to offline or vice versa.
```javascript
chat.onMemberStatusChanged((memberId,status) => {
//do something when a user status changes
})
```
**Response**
| Field | Type | Description |
|---|
memberId | string | the id of the user who's status has changed |
| status | enum | the status of the user. an enum of either ONLINE or OFFLINE |
### Listen for AI Actions
Is triggered when an action configured on an AI agent is executed.
```javascript
chat.onAiAction(({event, chatbotUsername}) => {
//do something with
})
```
| Field | Type | Description |
|---|
event | string | The event name, this is defined on the minchat dashboard when creating/updating an AI Agent |
chatbotUsername | string | the username of the AI agent that triggered the event |
## Functions
### Get Messages
Messages retrieved in a conversation are paginated to 25 messages at a time.
{% tabs %}
{% tab title="async/await" %}
```javascript
const { messages , page , totalMessages , totalPages } = await chat.getMessages(1 /** page to query **/ )
```
{% endtab %}
{% tab title="callback" %}
```javascript
chat.getMessages(1 /** page to query **/)
.then(({ messages , page , totalMessages , totalPages }) => {
//do something with the messages
})
```
{% endtab %}
{% endtabs %}
**Parameters**
| Field | Type | State | Description |
|---|
page | number | optional | query a specific page of messages, each page contains 25 messages. if null or undefined then the most recent 25 messages are returned |
**Response**
| Field | Type | Description |
|---|
messages | Message[] | array of messages |
page | number | shows the current page of messages. each page contains 25 messages |
totalMessages | number | shows the total number of messages that exist |
totalPages | number | shows the total number of pages of messages that exist. each page contains 25 messages |
### Send Message
To send a message, call a function on the chat object.
const message = {
text: "Hello World!"
}
const callback = (data)=> { /**
do something
*/}
chat.sendMessage(message, callback)
**`Message` Parameters**
| Field | Type | State | Description |
|---|
text | string | optional | the text of the message |
file | File | optional | upload a file as an attachment |
metadata | json object | optional | an optional key value pair for any additional message information such as custom font size, font type, or JSON formatted string. accepts string,number and boolean values |
**Callback**
| Field | Type | Description |
|---|
data | Message | the message that was sent |
### Update Message
const message = {
text: "Updated Hello World!"
}
const callback = (data)=> { /**
do something
*/}
chat.updateMessage(messageId, message, callback)
**Parameters**
| Field | Type | State | Description |
|---|
messageId | string | required | the id of the message to be updated |
**`Message` Parameters**
| Field | Type | State | Description |
|---|
text | string | optional | the text of the message |
file | File | optional | upload a file as an attachment |
metadata | json object | optional | an optional key value pair for any additional message information such as custom font size, font type, or JSON formatted string. accepts string,number and boolean values |
**Callback**
| Field | Type | Description |
|---|
data | Message | the message that was updated |
### Delete Message
chat.deleteMessage(messageId)
**Parameters**
| Field | Type | Description |
|---|
messageId | string | the Id of the message to delete |
### Get ID
Get the id of the conversation, returns a `string`
```javascript
const id = chat.getId()
```
### Get Title
Get the title of the conversation, returns a `string`
```javascript
const title = chat.getTitle()
```
### Get Conversation Avatar
Get the avatar of the chat, returns a `string` which is the url to the avatar
```javascript
const avatar = chat.getChatAvatar()
```
### Get recent message
Get the most recent message sent in the conversation. Returns a [`Message`](/reference/message.md) object.
```javascript
const message = chat.getLastMessage()
```
### Get Members
Get an array of all the [users](/reference/user.md) of this conversation
```javascript
const users = await chat.getMembers()
```
### Get MemberIds
Get an array of ids of all the members of this conversation
```javascript
const userIds = await chat.getMemberIds()
```
### Get Metadata
get an optional key value pair for any additional chat information.
```javascript
const metadata = chat.getMetadata()
```
### Set Metadata
Add any additional chat information.
```javascript
await chat.setMetaData(metadata)
```
**Parameters**
| Field | Type | State | Description |
|---|
metadata | json object | required | an optional key value pair for any additional chat information. Accepts string, number and boolean values |
### Add member to group chat
Add a member to a group chat
```typescript
await chat.addMember(username)
```
### Add member to group chat by ID
add a member to a group chat using a member ID
```typescript
await chat.addMemberById(userId)
```
### Remove member from group chat
Remove a member from a group chat
await chat.removeMember(username)
### Remove member from group chat by ID
Remove a member from a group chat using a member ID
await chat.removeMemberById(userId)
### Notify everyone typing started
Call this function to notify everyone who is a participant of the conversation that the current user has started typing
```javascript
chat.startTyping()
```
### Notify everyone typing stopped
Call this function to notify everyone who is a participant of the conversation that the current user has stopped typing
```javascript
chat.stopTyping()
```
### Set Message Seen
Call this function to notify participants of the conversation that a message has been seen. (useful when handling message seen states).
```javascript
chat.setSeen(messageId)
```
**Parameters**
| Field | Type | State | Description |
|---|
messageId | string | optional | the id of the message. If left null or undefined then the last message in the conversation is set as seen by the connected user. |
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.minchat.io/javascript-sdk/conversation-chat.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.