Chat

class Chat

Instance Properties

• chatId ID of this Chat
• isBlocked Is this chat blocked?
• isBookmarked Has this chat ever been bookmarked?
• lastMessage The most recent message in this chat
• o
• uiState Current state of this chat

Instance Methods

• acceptCall() Accept any incoming calls in this Chat
• addReaction(m:reaction:) Add new reaction to a message in this Chat
• block(reportSpam:spamMessage:onServer:) Block this chat so it will not re-open
• bookmark() Save this Chat on the server
• callStatus() The current status of a call in this chat
• canAudioCall() Can audio calls be started in this Chat?
• canInvite() Can the user invite others to this chat?
• canSend() Can the user send messages to this chat?
• canVideoCall() Can video calls be started in this Chat?
• close() Archive this chat
• commands()
• correctMessage(correct:message:) Correct an already-send message by replacing it with a new one
• dtmf() A DTMFSender for a call in this chat, or NULL
• encryptionMode() Get encryption mode for this chat
• getDisplayName() The display name of this Chat
• getMessagesAfter(after:) Fetch a page of messages after some point
• getMessagesAround(around:) Fetch a page of messages around (before, including, and after) some point
• getMessagesBefore(before:) Fetch a page of messages before some point
• getParticipantDetails(participantId:) Get the details for one participant in this Chat
• getParticipants() Get the list of IDs of participants in this Chat
• getPhoto() Get the URI image to represent this Chat, or null
• getPlaceholder() Get the URI to a placeholder image to represent this Chat
• hangup() Hangup or reject any calls in this chat
• hasCommands() Does this chat provide a menu of commands?
• invite(other:threadId:) Invite another chat’s participants to participate in this one
• invitedBy() The Participant that originally invited us to this Chat, if we were invited
• isApp() This chat’s primary mode of interaction is via commands
• isTrusted() Is this a chat with an entity we trust to see our online status?
• lastMessageId() An ID of the most recent message in this chat
• markReadUpTo(message:) Signals that all messages up to and including this one have probably been displayed to the user
• notificationsFiltered() Should notifications be filtered?
• notifyMention() Should a mention produce a notification?
• notifyReply() Should a reply produce a notification?
• preview() A preview of the chat, such as the most recent message body
• readUpTo() An ID of the last message displayed to the user
• removeReaction(m:reaction:) Remove an already-sent reaction from a message
• sendMessage(message:) Send a message to this Chat
• setActive(active:threadId:) Call this whenever the user makes a chat or thread “active” in your UX If you call this with true you MUST later call it will false
• setDisplayName(displayName:) Set the display name to use for this chat
• setNotifications(filtered:mention:reply:) Update notification preferences
• setTrusted(trusted:) Set if this chat is to be trusted with our presence, etc
• startCall(audio:video:) Start a new call in this Chat
• syncing()
• togglePinned() Pin or unpin this chat
• typing(threadId:content:) Call this whenever the user is typing, can call on every keystroke
• unblock(onServer:) Unblock this chat so it will open again
• unreadCount() The number of message that have not yet been displayed to the user
• videoTracks() All video tracks in all active calls in this chat