Class Chats

Chats

Date

2/1/2024 - 2:44:47 AM

Export

Chats

Constructors

constructor

new Chats(sdk: FilenSDK): Chats
Parameters
- sdk: FilenSDK
Returns Chats
- Defined in src/chats/index.ts:22

Methods

addParticipant

addParticipant(
param0: { contact: Contact; conversation: string },
): Promise<void>
Add a participant to a chat.
Parameters
- param0: { contact: Contact; conversation: string }
Returns Promise<void>
Date
2/20/2024 - 5:46:46 AM

Async
- Defined in src/chats/index.ts:493

chatKey

chatKey(param0: { conversation: string }): Promise<string>
Get the encryption key of a chat.
Parameters
- param0: { conversation: string }
Returns Promise<string>
Date
2/20/2024 - 6:05:30 AM

Async
- Defined in src/chats/index.ts:36

conversationOnline

conversationOnline(
param0: { conversation: string },
): Promise<ChatConversationsOnlineUser[]>
Get the online status of each participant in a conversation.
Parameters
- param0: { conversation: string }
Returns Promise<ChatConversationsOnlineUser[]>
Date
2/20/2024 - 6:09:47 AM

Async
- Defined in src/chats/index.ts:600

conversations

conversations(): Promise<ChatConversation[]>
Fetch all chat conversations.

Returns Promise<ChatConversation[]>
Date
2/20/2024 - 5:35:54 AM

Async
- Defined in src/chats/index.ts:82

conversationsRecents

conversationsRecents(): Promise<ChatConversation[]>
Fetch all recent chat conversations.

Returns Promise<ChatConversation[]>
Date
2/20/2024 - 5:37:59 AM

Async
- Defined in src/chats/index.ts:153

conversationUnreadCount

conversationUnreadCount(param0: { conversation: string }): Promise<number>
Get the notification count for a conversation.
Parameters
- param0: { conversation: string }
Returns Promise<number>
Date
2/20/2024 - 6:07:24 AM

Async
- Defined in src/chats/index.ts:570

create

create(param0: { contacts?: Contact[]; uuid?: string }): Promise<string>
Create a chat conversation. Optionally add participants to it.
Parameters
- param0: { contacts?: Contact[]; uuid?: string }
Returns Promise<string>
Date
2/20/2024 - 5:48:07 AM

Async
- Defined in src/chats/index.ts:195

delete

delete(param0: { conversation: string }): Promise<void>
Delete a chat conversation.
Parameters
- param0: { conversation: string }
Returns Promise<void>
Date
2/20/2024 - 6:15:57 AM

Async
- Defined in src/chats/index.ts:269

deleteMessage

deleteMessage(param0: { uuid: string }): Promise<void>
Delete a chat message.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/20/2024 - 5:52:09 AM

Async
- Defined in src/chats/index.ts:253

disableMessageEmbed

disableMessageEmbed(param0: { uuid: string }): Promise<void>
Disable a message embed.
Parameters
- param0: { uuid: string }
Returns Promise<void>
Date
2/20/2024 - 6:10:38 AM

Async
- Defined in src/chats/index.ts:616

editConversationName

editConversationName(
param0: { conversation: string; name: string },
): Promise<void>
Edit a conversation name.
Parameters
- param0: { conversation: string; name: string }
Returns Promise<void>
Date
2/20/2024 - 6:03:14 AM

Async
- Defined in src/chats/index.ts:292

editMessage

editMessage(
param0: { conversation: string; message: string; uuid: string },
): Promise<void>
Edit a chat message.
Parameters
- param0: { conversation: string; message: string; uuid: string }
Returns Promise<void>
Date
2/20/2024 - 5:52:16 AM

Async
- Defined in src/chats/index.ts:325

get

get(param0: { conversation: string }): Promise<ChatConversation>
Fetch a chat conversation.
Parameters
- param0: { conversation: string }
Returns Promise<ChatConversation>
Date
2/20/2024 - 5:39:11 AM

Async
- Defined in src/chats/index.ts:169

lastFocus

lastFocus(): Promise<ChatLastFocusValues[]>
Fetch last focus.

Returns Promise<ChatLastFocusValues[]>
Date
2/20/2024 - 6:22:46 AM

Async
- Defined in src/chats/index.ts:646

leave

leave(param0: { conversation: string }): Promise<void>
Leave a conversation. Only works if you are not the owner.
Parameters
- param0: { conversation: string }
Returns Promise<void>
Date
2/20/2024 - 6:14:36 AM

Async
- Defined in src/chats/index.ts:632

markConversationAsRead

markConversationAsRead(param0: { conversation: string }): Promise<void>
Mark a conversation as read.
Parameters
- param0: { conversation: string }
Returns Promise<void>
Date
2/20/2024 - 6:06:21 AM

Async
- Defined in src/chats/index.ts:554

messages

messages(
param0: { conversation: string; timestamp?: number },
): Promise<ChatMessage[]>
Fetch chat messages from the given timestamp ordered DESC. Can be used for pagination.
Parameters
- param0: { conversation: string; timestamp?: number }
Returns Promise<ChatMessage[]>
Date
2/20/2024 - 6:00:37 AM

Async
- Defined in src/chats/index.ts:423

removeParticipant

removeParticipant(
param0: { conversation: string; userId: number },
): Promise<void>
Remove a participant from a chat.
Parameters
- param0: { conversation: string; userId: number }
Returns Promise<void>
Date
2/20/2024 - 5:49:45 AM

Async
- Defined in src/chats/index.ts:531

sendMessage

sendMessage(
    param0: {
        conversation: string;
        message: string;
        replyTo: string;
        uuid?: string;
    },
): Promise<string>
Send a message.
Parameters
- param0: { conversation: string; message: string; replyTo: string; uuid?: string }
Returns Promise<string>
Date
2/20/2024 - 5:54:24 AM

Async
- Defined in src/chats/index.ts:358

sendTyping

sendTyping(
param0: { conversation: string; type: ChatTypingType },
): Promise<void>
Send a typing event.
Parameters
- param0: { conversation: string; type: ChatTypingType }
Returns Promise<void>
Date
2/20/2024 - 5:55:20 AM

Async
- Defined in src/chats/index.ts:405

unread

unread(): Promise<number>
Get the unread notification count (includes all conversations).

Returns Promise<number>
Date
2/20/2024 - 6:08:07 AM

Async
- Defined in src/chats/index.ts:586

updateLastFocus

updateLastFocus(param0: { values: ChatLastFocusValues[] }): Promise<void>
Update last focus.
Parameters
- param0: { values: ChatLastFocusValues[] }
Returns Promise<void>
Date
2/20/2024 - 6:22:37 AM

Async
- Defined in src/chats/index.ts:660