class Channel

package borogove

extends Chat

import borogove.Chat

@:directlyUsed@:expose

Methods

description():String

isPrivate():Bool

Inherited Variables

Defined by Chat

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(Open)@:allow(borogove)read onlyuiState:UiState = Open

Current state of this chat

Inherited Methods

Defined by Chat

acceptCall():Void

Accept any incoming calls in this Chat

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

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

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

callStatus():CallStatus

The current status of a call in this chat

commands():Promise<Array<Command>>

dtmf():Null<DTMFSender>

A DTMFSender for a call in this chat, or NULL

encryptionMode():String

Get encryption mode for this chat

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

hangup():Void

Hangup or reject any calls in this chat

hasCommands():Bool

Does this chat provide a menu of commands?

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

notificationsFiltered():Bool

Should notifications be filtered?

notifyMention():Bool

Should a mention produce a notification?

notifyReply():Bool

Should a reply produce a notification?

readUpTo():Null<String>

An ID of the last message displayed to the user

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

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

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