Class CmdClass

constructor

• new CmdClass(): CmdClass

• Returns CmdClass

isMainLoaded

uiBusy

_openChat

• _openChat(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

_scrollChatToBottom

• _scrollChatToBottom(): void

• Returns void

_scrollToFocusedMsg

• _scrollToFocusedMsg(e?): void

• Parameters

  • Optional e: any

  Returns void

alertCall

• alertCall(e?, t?, r?, n?, i?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any
  • Optional n: any
  • Optional i: any

  Returns void

alertNewMsg

• alertNewMsg(e?): void

• Parameters

  • Optional e: any

  Returns void

archiveChat

• archiveChat(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

attachMediaDrawer

• attachMediaDrawer(e?): void

• Parameters

  • Optional e: any

  Returns void

attachProduct

• attachProduct(e?): void

• Parameters

  • Optional e: any

  Returns void

autoplayPTT

• autoplayPTT(e?): void

• Parameters

  • Optional e: any

  Returns void

bind

• bind(eventName, listener, context?): this

• Alias of on

  Parameters

  • eventName: Event
  • listener: Listener
  • Optional context: any

  Returns this

  Alias

  on

cancelCall

• cancelCall(e?): void

• Parameters

  • Optional e: any

  Returns void

cannotReachPhone

• cannotReachPhone(): void

• Returns void

chatInfoDrawer

• chatInfoDrawer(e?, t?, r?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any

  Returns void

chatSearch

• chatSearch(e?): void

• Parameters

  • Optional e: any

  Returns void

clearChat

• clearChat(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

closeChat

• closeChat(e?): void

• Parameters

  • Optional e: any

  Returns void

closeContextMenu

• closeContextMenu(e?): void

• Parameters

  • Optional e: any

  Returns void

closeDrawerLeft

• closeDrawerLeft(): void

• Returns void

closeDrawerMid

• closeDrawerMid(): void

• Returns void

closeDrawerRight

• closeDrawerRight(): void

• Returns void

closeModal

• closeModal(e?): void

• Parameters

  • Optional e: any

  Returns void

closeModalMedia

• closeModalMedia(): void

• Returns void

closeStatusViewer

• closeStatusViewer(): void

• Returns void

closeToast

• closeToast(e?): void

• Parameters

  • Optional e: any

  Returns void

closeTooltip

• closeTooltip(e?): void

• Parameters

  • Optional e: any

  Returns void

criticalSyncDone

• criticalSyncDone(): void

• Returns void

deleteOrExitChat

• deleteOrExitChat(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

downgradeWebclient

• downgradeWebclient(): void

• Returns void

emit

• emit(eventName, ...args): this

• Alias of trigger

  Parameters

  • eventName: Event
  • Rest ...args: any[]

  Returns this

  Alias

  trigger

enterChatTextInput

• enterChatTextInput(e?): void

• Parameters

  • Optional e: any

  Returns void

ephemeralDrawer

• ephemeralDrawer(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

existsDrawerLeft

• existsDrawerLeft(e?): void

• Parameters

  • Optional e: any

  Returns void

existsDrawerMid

• existsDrawerMid(e?): void

• Parameters

  • Optional e: any

  Returns void

existsDrawerRight

• existsDrawerRight(e?): void

• Parameters

  • Optional e: any

  Returns void

expiredLocationDrawer

• expiredLocationDrawer(e?): void

• Parameters

  • Optional e: any

  Returns void

flashFocusedMsg

• flashFocusedMsg(e?): void

• Parameters

  • Optional e: any

  Returns void

floaterEscapeOverlap

• floaterEscapeOverlap(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

focusChatList

• focusChatList(): void

• Returns void

focusChatSearch

• focusChatSearch(): void

• Returns void

focusChatTextInput

• focusChatTextInput(e?): void

• Parameters

  • Optional e: any

  Returns void

focusNextChat

• focusNextChat(e?): void

• Parameters

  • Optional e: any

  Returns void

focusPrevChat

• focusPrevChat(e?): void

• Parameters

  • Optional e: any

  Returns void

focusShowMsg

• focusShowMsg(e?): void

• Parameters

  • Optional e: any

  Returns void

getConversationHeaderOffset

• getConversationHeaderOffset(e?): void

• Parameters

  • Optional e: any

  Returns void

handleFatalError

• handleFatalError(): void

• Returns void

handleOfflineProgressUpdate

• handleOfflineProgressUpdate(): void

• Returns void

incrementProgress

• incrementProgress(): void

• Returns void

initialLoadReady

• initialLoadReady(): void

• Returns void

isListening

• isListening(eventName): boolean

• Parameters

  • eventName: Event

  Returns boolean

listenTo

• listenTo(context, eventName, listener?): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

listenToAndRun

• listenToAndRun(context, eventName, listener?): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

listenToOnce

• listenToOnce(context, eventName, listener?): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

liveLocationDrawer

• liveLocationDrawer(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

logSocketSummary

• logSocketSummary(): void

• Returns void

login

• login(e?): void

• Parameters

  • Optional e: any

  Returns void

logout

• logout(): void

• Returns void

mainLoaded

• mainLoaded(): void

• Returns void

markChatUnread

• markChatUnread(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

mediaPlaying

• mediaPlaying(e?): void

• Parameters

  • Optional e: any

  Returns void

mediaViewerModal

• mediaViewerModal(e?): void

• Parameters

  • Optional e: any

  Returns void

merchantDetailsDrawer

• merchantDetailsDrawer(e?): void

• Parameters

  • Optional e: any

  Returns void

midnight

• midnight(): void

• Returns void

msgInfoDrawer

• msgInfoDrawer(e?): void

• Parameters

  • Optional e: any

  Returns void

muteAll

• muteAll(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

muteAllCall

• muteAllCall(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

muteChat

• muteChat(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

muteChats

• muteChats(e?, t?, r?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any

  Returns void

newMediaMsg

• newMediaMsg(e?): void

• Parameters

  • Optional e: any

  Returns void

off

• off(eventName?, listener?, context?): this

• Removes the specified listener from the listener array for the event named eventName.

  Parameters

  • Optional eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.
  • Optional context: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

on

• on(eventName, listener, context?): this

• Adds the listener function to the end of the listeners array for the event named eventName.

  Parameters

  • eventName: Event

    The name of the event.
  • listener: Listener

    The callback function.
  • Optional context: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

onFullChatHistorySynced

• onFullChatHistorySynced(): void

• Returns void

onHistorySyncChunkProcessed

• onHistorySyncChunkProcessed(e?): void

• Parameters

  • Optional e: any

  Returns void

onInitialChatHistorySynced

• onInitialChatHistorySynced(): void

• Returns void

onPanesDidChange

• onPanesDidChange(e?): void

• Parameters

  • Optional e: any

  Returns void

onPanesWillChange

• onPanesWillChange(e?): void

• Parameters

  • Optional e: any

  Returns void

onRecentChatHistorySynced

• onRecentChatHistorySynced(): void

• Returns void

onStartingLogout

• onStartingLogout(): void

• Returns void

onTemporaryBan

• onTemporaryBan(e?): void

• Parameters

  • Optional e: any

  Returns void

once

• once(eventName, listener, context?): this

• Adds a one-time listener function for the event named eventName.

  Parameters

  • eventName: Event

    The name of the event.
  • listener: Listener

    The callback function.
  • Optional context: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

openChatAt

• openChatAt(chat, context): Promise<boolean>

• Parameters

  • chat: ChatModel
  • context: {
        collection: MsgLoad;
        highlightMsg: true;
        key?: MsgKey;
        msg?: MsgModel;
    }

    • collection: MsgLoad

    • highlightMsg: true

    • Optional key?: MsgKey

    • Optional msg?: MsgModel

  Returns Promise<boolean>

openChatBottom

• openChatBottom(chat): Promise<boolean>

• Parameters

  • chat: ChatModel

  Returns Promise<boolean>

openChatFromUnread

• openChatFromUnread(chat): Promise<boolean>

• Parameters

  • chat: ChatModel

  Returns Promise<boolean>

openComposeBoxPanel

• openComposeBoxPanel(e?): void

• Parameters

  • Optional e: any

  Returns void

openContextMenu

• openContextMenu(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

openDrawerLeft

• openDrawerLeft(e?, t?, r?, n?, i?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any
  • Optional n: any
  • Optional i: any

  Returns void

openDrawerMid

• openDrawerMid(e?, t?, r?, n?, i?, a?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any
  • Optional n: any
  • Optional i: any
  • Optional a: any

  Returns void

openDrawerRight

• openDrawerRight(e?, t?, r?, n?, i?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any
  • Optional n: any
  • Optional i: any

  Returns void

openGroupInviteModal

• openGroupInviteModal(e?): void

• Parameters

  • Optional e: any

  Returns void

openGroupV4InviteRequestFlow

• openGroupV4InviteRequestFlow(e?, t?, r?, n?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any
  • Optional n: any

  Returns void

openMediaViewerForAlbumMedia

• openMediaViewerForAlbumMedia(e?): void

• Parameters

  • Optional e: any

  Returns void

openModal

• openModal(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

openModalMedia

• openModalMedia(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

openSocketStream

• openSocketStream(): void

• Returns void

openToast

• openToast(e?): void

• Parameters

  • Optional e: any

  Returns void

openTooltip

• openTooltip(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

pasteChatTextInput

• pasteChatTextInput(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

pinChat

• pinChat(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

pinChats

• pinChats(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

productImageViewerModal

• productImageViewerModal(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

pttPlaying

• pttPlaying(e?): void

• Parameters

  • Optional e: any

  Returns void

pttRecording

• pttRecording(): void

• Returns void

readyForMainStreamMode

• readyForMainStreamMode(): void

• Returns void

refreshMessages

• refreshMessages(): void

• Returns void

refreshQR

• refreshQR(): void

• Returns void

removeAllListeners

• removeAllListeners(): this

• Removes all listeners.

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

removeListener

• removeListener(eventName?, listener?, context?): this

• Alias of off

  Parameters

  • Optional eventName: Event
  • Optional listener: Listener
  • Optional context: any

  Returns this

  Alias

  off

restartBackend

• restartBackend(): void

• Returns void

scrollMessages

• scrollMessages(): void

• Returns void

scrollToPtt

• scrollToPtt(e?): void

• Parameters

  • Optional e: any

  Returns void

sendDeleteMsgs

• sendDeleteMsgs(chat, msgs, clearMedia?, toastPosition?): void

• Parameters

  • chat: ChatModel
  • msgs: MsgModel[]
  • Optional clearMedia: boolean
  • Optional toastPosition: any

  Returns void

sendPasteToCompose

• sendPasteToCompose(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

sendRevokeMsgs

• sendRevokeMsgs(chat, msgs, options?): void

• Parameters

  • chat: ChatModel
  • msgs: MsgModel[]
  • Optional options: {
        clearMedia?: boolean;
        toastPosition?: any;
    }

    • Optional clearMedia?: boolean

    • Optional toastPosition?: any

  Returns void

sendStarMsgs

• sendStarMsgs(chat, msgs, id?, toastPosition?): void

• Parameters

  • chat: ChatModel
  • msgs: MsgModel[]
  • Optional id: any
  • Optional toastPosition: any

  Returns void

sendUnstarMsgs

• sendUnstarMsgs(chat, msgs, id?, toastPosition?): void

• Parameters

  • chat: ChatModel
  • msgs: MsgModel[]
  • Optional id: any
  • Optional toastPosition: any

  Returns void

sentPing

• sentPing(): void

• Returns void

serverPropsUpdated

• serverPropsUpdated(): void

• Returns void

setChatCtwaContextLinkData

• setChatCtwaContextLinkData(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

setDrawerContext

• setDrawerContext(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

setSocketState

• setSocketState(e?): void

• Parameters

  • Optional e: any

  Returns void

setUiBusy

• setUiBusy(e?): void

• Parameters

  • Optional e: any

  Returns void

showCountrySelector

• showCountrySelector(e?, t?, r?): void

• Parameters

  • Optional e: any
  • Optional t: any
  • Optional r: any

  Returns void

showMerchantDetailsEntityTypePopup

• showMerchantDetailsEntityTypePopup(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

socketStreamDisconnected

• socketStreamDisconnected(): void

• Returns void

startGroupCall

• startGroupCall(e?, t?): void

• Parameters

  • Optional e: any
  • Optional t: any

  Returns void

stopListening

• stopListening(context?, eventName?, listener?): this

• Parameters

  • Optional context: any
  • Optional eventName: Event
  • Optional listener: Listener

  Returns this

storageInitializationError

• storageInitializationError(): void

• Returns void

textsizeChange

• textsizeChange(e?): void

• Parameters

  • Optional e: any

  Returns void

toggleStickerMaker

• toggleStickerMaker(): void

• Returns void

trigger

• trigger(eventName, ...args): this

• Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

  Parameters

  • eventName: Event
  • Rest ...args: any[]

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

uiResize

• uiResize(): void

• Returns void

unbind

• unbind(eventName?, listener?, context?): this

• Alias of off

  Parameters

  • Optional eventName: Event
  • Optional listener: Listener
  • Optional context: any

  Returns this

  Alias

  off

updateChatlistSelection

• updateChatlistSelection(e?): void

• Parameters

  • Optional e: any

  Returns void

upgradeToMDInternal

• upgradeToMDInternal(): void

• Returns void

upgradeToMDProd

• upgradeToMDProd(): void

• Returns void

verificationDrawer

• verificationDrawer(e?): void

• Parameters

  • Optional e: any

  Returns void

windowClick

• windowClick(e?): void

• Parameters

  • Optional e: any

  Returns void

windowError

• windowError(): void

• Returns void

windowMouseDown

• windowMouseDown(e?): void

• Parameters

  • Optional e: any

  Returns void