Class SupportChat

Hierarchy

Chat
- SupportChat

Constructors

`Private` constructor

new SupportChat(supportChatId: string, chatService: SupportChatService): SupportChat
Parameters
- supportChatId: string
- chatService: SupportChatService
Returns SupportChat
Inherited from Chat.constructor
- Defined in src/chat/SupportChat.ts:19

Properties

`Private` chatService

chatService: SupportChatService

emitter

emitter: EventEmitter2

`Readonly` firstUnreadMessage

firstUnreadMessage: ChatMessage

`Readonly` messages

messages: List<ChatMessage>

`Private` supportChatId

supportChatId: string

Methods

addParticipant

addParticipant(participant: string): Promise<void>
Parameters
- participant: string
Returns Promise<void>
Inherited from Chat.addParticipant
- Defined in src/chat/Chat.d.ts:14

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from Chat.archive
- Defined in src/chat/Chat.d.ts:15

cancelPendingMessage

cancelPendingMessage(message: ChatMessage): Promise<void>
Parameters
- message: ChatMessage
Returns Promise<void>
Inherited from Chat.cancelPendingMessage
- Defined in src/chat/Chat.d.ts:16

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from Chat.delete
- Defined in src/chat/Chat.d.ts:17

expelParticipant

expelParticipant(participant: string): Promise<void>
Parameters
- participant: string
Returns Promise<void>
Inherited from Chat.expelParticipant
- Defined in src/chat/Chat.d.ts:18

fetch

fetch(minimum?: number): Promise<void>
Parameters
- Optional minimum: number
Returns Promise<void>
Inherited from Chat.fetch
- Defined in src/chat/Chat.d.ts:19

getFileMessages

getFileMessages(): List<ChatMessage>
Returns List<ChatMessage>
Inherited from Chat.getFileMessages
- Defined in src/chat/Chat.d.ts:20

getFirstUnreadMessage

getFirstUnreadMessage(): ChatMessage
Returns ChatMessage
Inherited from Chat.getFirstUnreadMessage
- Defined in src/chat/Chat.d.ts:22

getFirstUnreadMessage$

getFirstUnreadMessage$(): Observable<ChatMessage>
Returns Observable<ChatMessage>
Inherited from Chat.getFirstUnreadMessage$
- Defined in src/chat/Chat.d.ts:23

getId

getId(): string
Returns string
Inherited from Chat.getId
- Defined in src/chat/Chat.d.ts:24

getMessages

getMessages(): List<ChatMessage>
Returns List<ChatMessage>
Inherited from Chat.getMessages
- Defined in src/chat/Chat.d.ts:26

getMessages$

getMessages$(): Observable<List<ChatMessage>>
Returns Observable<List<ChatMessage>>
Inherited from Chat.getMessages$
- Defined in src/chat/Chat.d.ts:27

getName

getName(): string
Returns string
Inherited from Chat.getName
- Defined in src/chat/Chat.d.ts:28

getParticipants

getParticipants(): Map<string, ChatParticipantRole>
Returns Map<string, ChatParticipantRole>
Inherited from Chat.getParticipants
- Defined in src/chat/Chat.d.ts:29

getPendingMessages

getPendingMessages(): List<ChatMessage>
Returns List<ChatMessage>
Inherited from Chat.getPendingMessages
- Defined in src/chat/Chat.d.ts:30

getRemoteParticipants

getRemoteParticipants(): Map<string, ChatParticipantState>
Returns Map<string, ChatParticipantState>
Inherited from Chat.getRemoteParticipants
- Defined in src/chat/Chat.d.ts:31

getRole

getRole(): ChatParticipantRole
Returns ChatParticipantRole
Inherited from Chat.getRole
- Defined in src/chat/Chat.d.ts:32

getSubject

getSubject(): string
Returns string
Inherited from Chat.getSubject
- Defined in src/chat/Chat.d.ts:33

getType

getType(): ChatType
Returns ChatType
Inherited from Chat.getType
- Defined in src/chat/Chat.d.ts:34

getUnreadMessageCount

getUnreadMessageCount(): number
Returns number
Inherited from Chat.getUnreadMessageCount
- Defined in src/chat/Chat.d.ts:36

getUnreadMessageCount$

getUnreadMessageCount$(): Observable<number>
Returns Observable<number>
Inherited from Chat.getUnreadMessageCount$
- Defined in src/chat/Chat.d.ts:35

isOldestMessageRecovered

isOldestMessageRecovered(): boolean
Returns boolean
Inherited from Chat.isOldestMessageRecovered
- Defined in src/chat/Chat.d.ts:44

leave

leave(): Promise<void>
Leaves the current Support Chat

If leaving participant is the chat's agent, the support chat is finished.

Returns

Returns Promise<void>
Inherited from Chat.leave
- Defined in src/chat/SupportChat.ts:43

resetUnreadMessageCount

resetUnreadMessageCount(): Promise<void>
Returns Promise<void>
Inherited from Chat.resetUnreadMessageCount
- Defined in src/chat/Chat.d.ts:38

sendFile

sendFile(file: File): Promise<FileUpload>
Parameters
- file: File
Returns Promise<FileUpload>
Inherited from Chat.sendFile
- Defined in src/chat/Chat.d.ts:39

sendText

sendText(text: string): Promise<void>
Parameters
- text: string
Returns Promise<void>
Inherited from Chat.sendText
- Defined in src/chat/Chat.d.ts:40

setParticipantRole

setParticipantRole(participant: string, role: ChatParticipantRole): Promise<void>
Parameters
- participant: string
- role: ChatParticipantRole
Returns Promise<void>
Inherited from Chat.setParticipantRole
- Defined in src/chat/Chat.d.ts:41

setState

setState(state: ChatParticipantState): Promise<void>
Parameters
- state: ChatParticipantState
Returns Promise<void>
Inherited from Chat.setState
- Defined in src/chat/Chat.d.ts:42

setSubject

setSubject(subject: string): Promise<void>
Parameters
- subject: string
Returns Promise<void>
Inherited from Chat.setSubject
- Defined in src/chat/Chat.d.ts:43

sync

sync(): Promise<void>
Returns Promise<void>
Inherited from Chat.sync
- Defined in src/chat/Chat.d.ts:45

transfer

transfer(destination: SupportChatParticipant): Promise<void>
Transfers the current Support Chat to another agent

Changes the agent who is assigned to this support chat. The backend will generate an XMPP invitation to that destination agent.

Returns
Parameters
- destination: SupportChatParticipant
  
  The agent we want to transfer this chat to
Returns Promise<void>
- Defined in src/chat/SupportChat.ts:60

`Static` create

create(supportChatId: string, chatService: SupportChatService, chat: Chat): SupportChat
Parameters
- supportChatId: string
- chatService: SupportChatService
- chat: Chat
Returns SupportChat
- Defined in src/chat/SupportChat.ts:24

Generated using TypeDoc