Class ConversationMediator

Hierarchy

EventPropagator<Payloads, ConversationEvents>
- ConversationMediator

Implements

ConversationMediatorInterface

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConversationMediator(user: User): ConversationMediator

Overrides EventPropagator.constructor
- Defined in api/messaging/conversation.ts:40
Parameters
- user: User
Returns ConversationMediator

Properties

Protected callbacks

callbacks: object

An array of callbacks per event name

Type declaration

[eventName: string]: function[]

channel

channel: Channel

debugEvents

debugEvents: boolean = false

me

me: User

them

them: User

Methods

Protected attachSelf

attachSelf(on: EventPropagatorAttachFunction): void

Overrides EventPropagator.attachSelf
- Defined in api/messaging/conversation.ts:55
Parameters
- on: EventPropagatorAttachFunction
Returns void

detach

detach(): void

Overrides EventPropagator.detach
- Defined in api/messaging/conversation.ts:159
Returns void

dispatch

dispatch<T>(name: T, payload: Payloads[T]): void

Inherited from EventListener.dispatch
- Defined in lib/event-listener.ts:70
Dispatch an event.

Type parameters
- T: ConversationEvents
Parameters
- name: T
- payload: Payloads[T]
Returns void

dispose

dispose(): void

Implementation of ConversationMediatorInterface.dispose

Inherited from EventPropagator.dispose
- Defined in lib/event-propagator.ts:79
Dispose of all listeners. Should be called before the instance is garbage collected.

Returns void

Protected doAttachSelf

doAttachSelf(): void

Inherited from EventPropagator.doAttachSelf
- Defined in lib/event-propagator.ts:46
Function that calls the attachSelf function. Should be called in constructor.

Returns void

fetchMessages

fetchMessages(): function

Implementation of ConversationMediatorInterface.fetchMessages
- Defined in api/messaging/conversation.ts:98
Fetch newest messages

Returns function
- - (): Promise<ContinuousResponse<NormalizedMessage[]>>
  - Returns Promise<ContinuousResponse<NormalizedMessage[]>>

off

off<T>(name: T, callback: EventCallback<Payloads, T>): void

Inherited from EventListener.off
- Defined in lib/event-listener.ts:42
Detach an event listener from an event.

Type parameters
- T: ConversationEvents
Parameters
- name: T
- callback: EventCallback<Payloads, T>
Returns void

on

on<T>(name: T, callback: EventCallback<Payloads, T>): void

Inherited from EventListener.on
- Defined in lib/event-listener.ts:29
Attach an event listener to an event.

Type parameters
- T: ConversationEvents
Parameters
- name: T
- callback: EventCallback<Payloads, T>
Returns void

once

once<T>(name: T, callback: EventCallback<Payloads, T>): void

Inherited from EventListener.once
- Defined in lib/event-listener.ts:56
Attach an event listener to an event, but only once.

Type parameters
- T: ConversationEvents
Parameters
- name: T
- callback: EventCallback<Payloads, T>
Returns void

sendMessage

sendMessage(content: string, additional: MessageAdditional): IntermediateMessage

Implementation of ConversationMediatorInterface.sendMessage
- Defined in api/messaging/conversation.ts:109
Send a message.

Parameters
- content: string
- additional: MessageAdditional
Returns IntermediateMessage

sendReceived

sendReceived(message: number | Message, read: boolean): void

- Defined in api/messaging/conversation.ts:144
Send a 'message was received' notification

Parameters
- message: number | Message
- read: boolean
  
  Whether the user has read the message or only received it.
Returns void

sendTyping

sendTyping(typing: boolean): void

Implementation of ConversationMediatorInterface.sendTyping
- Defined in api/messaging/conversation.ts:130
Send 'user is typing' notification to user

Parameters
- typing: boolean
Returns void

Generated using TypeDoc