Class Chats

Chats

Date

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

Export

Constructors

constructor

new Chats(params): Chats
Creates an instance of Chats.
Parameters
- params: ChatsConfig
Returns Chats
Date
2/9/2024 - 5:54:11 AM
- Defined in src/chats/index.ts:40

Properties

`Private` `Readonly` _chatKeyCache

_chatKeyCache: Map<string, string> = ...

`Private` `Readonly` api

api: API

`Private` `Readonly` crypto

crypto: Crypto

`Private` `Readonly` sdkConfig

sdkConfig: FilenSDKConfig

Methods

addParticipant

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

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

chatKey

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

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

conversationOnline

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

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

conversationUnreadCount

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

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

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:99

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:162

create

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

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

delete

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

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

deleteMessage

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

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

disableMessageEmbed

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

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

editConversationName

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

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

editMessage

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

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

get

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

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

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:537

leave

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

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

markConversationAsRead

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

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

messages

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

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

removeParticipant

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

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

sendMessage

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

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

sendTyping

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

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

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:483

updateLastFocus

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

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

Generated using TypeDoc