borogove.Chat

Variables

`read onlychatId:String`

ID of this Chat

`@:value(false)read onlyisBlocked:Bool = false`

Is this chat blocked?

`@:value(false)read onlyisBookmarked:Bool = false`

Has this chat ever been bookmarked?

`read onlylastMessage:Null<ChatMessage>`

The most recent message in this chat

`@:value(new Status("", ""))@:allow(borogove)read onlystatus:Status = new Status("", "")`

`@:value(Open)@:allow(borogove)read onlyuiState:UiState = Open`

Current state of this chat

Methods

`acceptCall():Void`

Accept any incoming calls in this Chat

`@HaxeCBridge.noemitaddMedia(streams:Array<MediaStream>):Void`

Add additional media streams to the active call in this chat.

Parameters:

`streams`	media streams to add to the current session

`addReaction(m:ChatMessage, reaction:Reaction):Void`

Add new reaction to a message in this Chat

Parameters:

`m`	ChatMessage to react to
`reaction`	emoji of the reaction

`addRole(participantId:String, role:Role):Void`

Add a role to a participant

`availableRoles(participantId:String):Array<Role>`

Roles the current user can assign to the target participant

`@:value({ onServer : true, spamMessage : null, reportSpam : false })block(reportSpam:Bool = false, ?spamMessage:ChatMessage, onServer:Bool = true):Void`

Block this chat so it will not re-open

`bookmark():Void`

Save this Chat on the server

`callStatus():CallStatus`

The current status of a call in this chat

`canAudioCall():Bool`

Can audio calls be started in this Chat?

`canInvite():Bool`

Can the user invite others to this chat?

`canModerate():Bool`

Can the user send messages to this chat?

`canRemoveRole(participantId:String, role:Role):Bool`

Can the current user remove this role from the participant?

`canSend():Bool`

Can the user send messages to this chat?

`canVideoCall():Bool`

Can video calls be started in this Chat?

`close():Void`

Archive this chat

`commands():Promise<Array<Command>>`

List commands exposed by this chat

`correctMessage(correct:ChatMessage, message:ChatMessageBuilder):Void`

Correct an already-send message by replacing it with a new one

Parameters:

`correct`	the ChatMessage to correct
`message`	the new ChatMessageBuilder to replace it with

`dtmf():Null<DTMFSender>`

A DTMFSender for a call in this chat, or NULL

`encryptionMode():String`

Get encryption mode for this chat

`getDisplayName():String`

The display name of this Chat

`getMessagesAfter(after:Null<ChatMessage>):Promise<Array<ChatMessage>>`

Fetch a page of messages after some point

Parameters:

`after`	ChatMessage to look after, or null to start at the beginning

Returns:

Promise resolving to an array of ChatMessage that are found

`getMessagesAround(around:ChatMessage):Promise<Array<ChatMessage>>`

Fetch a page of messages around (before, including, and after) some point

Parameters:

`around`	ChatMessage to look around

Returns:

Promise resolving to an array of ChatMessage that are found

`getMessagesBefore(before:Null<ChatMessage>):Promise<Array<ChatMessage>>`

Fetch a page of messages before some point

Parameters:

`before`	ChatMessage to look before, or null to start at the end

Returns:

Promise resolving to an array of ChatMessage that are found

`getParticipantDetails(participantId:String):Participant`

Get the details for one participant in this Chat

Parameters:

`participantId`	the ID of the participant to look up

`getParticipants():Array<String>`

Get the list of IDs of participants in this Chat

Returns:

array of IDs

`getPhoto():Null<String>`

Get the URI image to represent this Chat, or null

`getPlaceholder():String`

Get the URI to a placeholder image to represent this Chat

`getTags():Array<String>`

Tags on this Chat

`hangup():Void`

Hangup or reject any calls in this chat

`hasCommands():Bool`

Does this chat provide a menu of commands?

`@:value({ threadId : null })invite(other:Chat, ?threadId:String):Void`

Invite another chat's participants to participate in this one

`invitedBy():Null<Participant>`

The Participant that originally invited us to this Chat, if we were invited

`isApp():Bool`

This chat's primary mode of interaction is via commands

`isTrusted():Bool`

Is this a chat with an entity we trust to see our online status?

`lastMessageId():Null<String>`

An ID of the most recent message in this chat

`markReadUpTo(message:ChatMessage):Void`

Signals that all messages up to and including this one have probably been displayed to the user

Parameters:

`message`	the ChatMessage most recently displayed

`moderate(message:ChatMessage, reason:String):Void`

Moderate a message by replacing it with a tombstone (if permitted)

Parameters:

`message`	the message to moderate
`reason`	the reason for moderating this message

`notificationsFiltered():Bool`

Should notifications be filtered?

`notifyMention():Bool`

Should a mention produce a notification?

`notifyReply():Bool`

Should a reply produce a notification?

`preview():String`

A preview of the chat, such as the most recent message body

`readUpTo():Promise<Null<ChatMessage>>`

An ID of the last message displayed to the user

`removeReaction(m:ChatMessage, reaction:Reaction):Void`

Remove an already-sent reaction from a message

Parameters:

`m`	ChatMessage to remove the reaction from
`reaction`	the emoji to remove

`removeRole(participantId:String, role:Role):Void`

Remove a role from a participant

`sendMessage(message:ChatMessageBuilder):Void`

Send a message to this Chat

Parameters:

`message`	the ChatMessageBuilder to send

`setActive(active:Bool, threadId:Null<String>):Void`

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

Parameters:

`active`	true if the chat is "active", false otherwise
`threadId`	optional, what thread the user has selected if any

`setDisplayName(displayName:String):Void`

Set the display name to use for this chat

Parameters:

`displayName`	String to use as display name

`setNotifications(filtered:Bool, mention:Bool, reply:Bool):Void`

Update notification preferences

`setTrusted(trusted:Bool):Void`

Set if this chat is to be trusted with our presence, etc

Parameters:

`trusted`	Bool if trusted or not

`startCall(audio:Bool, video:Bool):Session`

Start a new call in this Chat

Parameters:

`audio`	do we want audio in this call
`video`	do we want video in this call

`syncing():Bool`

Returns:

if this chat is currently syncing with the server

`togglePinned():Void`

Pin or unpin this chat

`typing(threadId:Null<String>, content:Null<String>):Void`

Call this whenever the user is typing, can call on every keystroke

Parameters:

`threadId`	optional, what thread the user has selected if any
`content`	optional, what the user has typed so far

`@:value({ onServer : true })unblock(onServer:Bool = true):Void`

Unblock this chat so it will open again

`unreadCount():Int`

The number of message that have not yet been displayed to the user

`videoTracks():Array<MediaStreamTrack>`

All video tracks in all active calls in this chat

class Chat

package borogove

extended by Channel, DirectChat

Variables

read onlychatId:String

@:value(false)read onlyisBlocked:Bool = false

@:value(false)read onlyisBookmarked:Bool = false

read onlylastMessage:Null<ChatMessage>

@:value(new Status("", ""))@:allow(borogove)read onlystatus:Status = new Status("", "")

@:value(Open)@:allow(borogove)read onlyuiState:UiState = Open

Methods

acceptCall():Void

@HaxeCBridge.noemitaddMedia(streams:Array<MediaStream>):Void

addReaction(m:ChatMessage, reaction:Reaction):Void

addRole(participantId:String, role:Role):Void

availableRoles(participantId:String):Array<Role>

@:value({ onServer : true, spamMessage : null, reportSpam : false })block(reportSpam:Bool = false, ?spamMessage:ChatMessage, onServer:Bool = true):Void

bookmark():Void

callStatus():CallStatus

canAudioCall():Bool

canInvite():Bool

canModerate():Bool

canRemoveRole(participantId:String, role:Role):Bool

canSend():Bool

canVideoCall():Bool

close():Void

commands():Promise<Array<Command>>

correctMessage(correct:ChatMessage, message:ChatMessageBuilder):Void

dtmf():Null<DTMFSender>

encryptionMode():String

getDisplayName():String

getMessagesAfter(after:Null<ChatMessage>):Promise<Array<ChatMessage>>

getMessagesAround(around:ChatMessage):Promise<Array<ChatMessage>>

getMessagesBefore(before:Null<ChatMessage>):Promise<Array<ChatMessage>>

getParticipantDetails(participantId:String):Participant

getParticipants():Array<String>

getPhoto():Null<String>

getPlaceholder():String

getTags():Array<String>

hangup():Void

hasCommands():Bool

@:value({ threadId : null })invite(other:Chat, ?threadId:String):Void

invitedBy():Null<Participant>

isApp():Bool

isTrusted():Bool

lastMessageId():Null<String>

markReadUpTo(message:ChatMessage):Void

moderate(message:ChatMessage, reason:String):Void

notificationsFiltered():Bool

notifyMention():Bool

notifyReply():Bool

preview():String

readUpTo():Promise<Null<ChatMessage>>

removeReaction(m:ChatMessage, reaction:Reaction):Void

removeRole(participantId:String, role:Role):Void

sendMessage(message:ChatMessageBuilder):Void

setActive(active:Bool, threadId:Null<String>):Void

setDisplayName(displayName:String):Void

setNotifications(filtered:Bool, mention:Bool, reply:Bool):Void

setTrusted(trusted:Bool):Void

startCall(audio:Bool, video:Bool):Session

syncing():Bool

togglePinned():Void

typing(threadId:Null<String>, content:Null<String>):Void

@:value({ onServer : true })unblock(onServer:Bool = true):Void

unreadCount():Int

videoTracks():Array<MediaStreamTrack>

`read onlychatId:String`

`@:value(false)read onlyisBlocked:Bool = false`

`@:value(false)read onlyisBookmarked:Bool = false`

`read onlylastMessage:Null<ChatMessage>`

`@:value(new Status("", ""))@:allow(borogove)read onlystatus:Status = new Status("", "")`

`@:value(Open)@:allow(borogove)read onlyuiState:UiState = Open`

`acceptCall():Void`

`@HaxeCBridge.noemitaddMedia(streams:Array<MediaStream>):Void`

`addReaction(m:ChatMessage, reaction:Reaction):Void`

`addRole(participantId:String, role:Role):Void`

`availableRoles(participantId:String):Array<Role>`

`@:value({ onServer : true, spamMessage : null, reportSpam : false })block(reportSpam:Bool = false, ?spamMessage:ChatMessage, onServer:Bool = true):Void`

`bookmark():Void`

`callStatus():CallStatus`

`canAudioCall():Bool`

`canInvite():Bool`

`canModerate():Bool`

`canRemoveRole(participantId:String, role:Role):Bool`

`canSend():Bool`

`canVideoCall():Bool`

`close():Void`

`commands():Promise<Array<Command>>`

`correctMessage(correct:ChatMessage, message:ChatMessageBuilder):Void`

`dtmf():Null<DTMFSender>`

`encryptionMode():String`

`getDisplayName():String`

`getMessagesAfter(after:Null<ChatMessage>):Promise<Array<ChatMessage>>`

`getMessagesAround(around:ChatMessage):Promise<Array<ChatMessage>>`

`getMessagesBefore(before:Null<ChatMessage>):Promise<Array<ChatMessage>>`

`getParticipantDetails(participantId:String):Participant`

`getParticipants():Array<String>`

`getPhoto():Null<String>`

`getPlaceholder():String`

`getTags():Array<String>`

`hangup():Void`

`hasCommands():Bool`

`@:value({ threadId : null })invite(other:Chat, ?threadId:String):Void`

`invitedBy():Null<Participant>`

`isApp():Bool`

`isTrusted():Bool`

`lastMessageId():Null<String>`

`markReadUpTo(message:ChatMessage):Void`

`moderate(message:ChatMessage, reason:String):Void`

`notificationsFiltered():Bool`

`notifyMention():Bool`

`notifyReply():Bool`

`preview():String`

`readUpTo():Promise<Null<ChatMessage>>`

`removeReaction(m:ChatMessage, reaction:Reaction):Void`

`removeRole(participantId:String, role:Role):Void`

`sendMessage(message:ChatMessageBuilder):Void`

`setActive(active:Bool, threadId:Null<String>):Void`

`setDisplayName(displayName:String):Void`

`setNotifications(filtered:Bool, mention:Bool, reply:Bool):Void`

`setTrusted(trusted:Bool):Void`

`startCall(audio:Bool, video:Bool):Session`

`syncing():Bool`

`togglePinned():Void`

`typing(threadId:Null<String>, content:Null<String>):Void`

`@:value({ onServer : true })unblock(onServer:Bool = true):Void`

`unreadCount():Int`

`videoTracks():Array<MediaStreamTrack>`