Readonly Internal_Conversation links for REST requests.
Readonly Internal_Map of participants.
ReadonlysidUnique system identifier of the conversation.
InternalSource of the conversation update.
Custom attributes of the conversation.
InternalConversation bindings. An undocumented feature (for now).
Identity of the user that created this conversation.
Date this conversation was created on.
Date this conversation was last updated on.
Name of the conversation.
Last message sent to this conversation.
Index of the last message the user has read in this conversation.
Current conversation limits.
User notification level for this conversation.
State of the conversation.
Status of the conversation.
Unique name of the conversation.
InternalFetch participants and messages of the conversation. This method needs to be called during conversation initialization to catch broken conversations (broken conversations are conversations that have essential Sync entities missing, i.e. the conversation document, the messages list or the participant map). In case of this conversation being broken, the method will throw an exception that will be caught and handled gracefully.
InternalSet conversation status.
InternalLoad and subscribe to this conversation and do not subscribe to its participants and messages. This or _subscribeStreams will need to be called before any events in the conversation will fire.
InternalLoad the attributes of this conversation and instantiate its participants and messages. This or _subscribe will need to be called before any events on the conversation will fire. This will need to be called before any events on participants or messages will fire
InternalStop listening for and firing events on this conversation.
InternalUpdate the local conversation object with new values.
Optional[captureThe Symbol.for('nodejs.rejection') method is called in case a
promise rejection happens when emitting an event and
captureRejections is enabled on the emitter.
It is possible to use events.captureRejectionSymbol in
place of Symbol.for('nodejs.rejection').
import { EventEmitter, captureRejectionSymbol } from 'node:events';
class MyClass extends EventEmitter {
constructor() {
super({ captureRejections: true });
}
[captureRejectionSymbol](err, event, ...args) {
console.log('rejection happened for', event, 'with', err, ...args);
this.destroy(err);
}
destroy(err) {
// Tear the resource down here.
}
}
Add a participant to the conversation by its identity.
Identity of the Client to add.
Optionalattributes: JSONValueAttributes to be attached to the participant.
The added participant.
Add a non-chat participant to the conversation.
Proxy (Twilio) address of the participant.
User address of the participant.
Optionalattributes: JSONValueAttributes to be attached to the participant.
OptionalbindingOptions: ParticipantBindingOptionsOptions for adding email participants - name and CC/To level.
The added participant.
Advance the conversation's last read message index to the current read horizon. Rejects if the user is not a participant of the conversation. Last read message index is updated only if the new index value is higher than the previous.
Message index to advance to.
Resulting unread messages count in the conversation.
Delete the conversation and unsubscribe from its events.
Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Returns an array listing the events for which the emitter has registered listeners.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
Get the custom attributes of this Conversation.
Get recipients of all messages in the conversation.
Optionaloptions: PaginatorOptionsOptional configuration, set pageSize to request a specific pagination page size. Page size specifies a number of messages to include in a single batch. Each message may include multiple recipients.
Returns messages from the conversation using the paginator interface.
OptionalpageSize: numberNumber of messages to return in a single chunk. Default is 30.
Optionalanchor: numberIndex of the newest message to fetch. Default is from the end.
Optionaldirection: "backwards" | "forward"Query direction. By default, it queries backwards
from newer to older. The "forward" value will query in the opposite
direction.
A page of messages.
Get the total message count in the conversation.
This method is semi-realtime. This means that this data will be eventually correct, but will also be possibly incorrect for a few seconds. The Conversations system does not provide real time events for counter values changes.
This is useful for any UI badges, but it is not recommended to build any core application logic based on these counters being accurate in real time.
Get a participant by its identity.
Optionalidentity: string | nullParticipant identity.
Get a participant by its SID.
Participant SID.
Get a list of all the participants who are joined to this conversation.
Get conversation participants count.
This method is semi-realtime. This means that this data will be eventually correct, but will also be possibly incorrect for a few seconds. The Conversations system does not provide real time events for counter values changes.
This is useful for any UI badges, but it is not recommended to build any core application logic based on these counters being accurate in real time.
Get count of unread messages for the user if they are a participant of this conversation. Rejects if the user is not a participant of the conversation.
Use this method to obtain the number of unread messages together with Conversation.updateLastReadMessageIndex instead of relying on the message indices which may have gaps. See Message.index for details.
This method is semi-realtime. This means that this data will be eventually correct, but it will also be possibly incorrect for a few seconds. The Conversations system does not provide real time events for counter values changes.
This is useful for any UI badges, but it is not recommended to build any core application logic based on these counters being accurate in real time.
If the read horizon is not set, this function will return null. This could mean
that all messages in the conversation are unread, or that the read horizon system
is not being used. How to interpret this null value is up to the customer application.
Number of unread messages based on the current read horizon set for
the user or null if the read horizon is not set.
Join the conversation and subscribe to its events.
Leave the conversation.
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
The name of the event being listened for
Optionallistener: (...args: any[]) => voidThe event handler function
Returns a copy of the array of listeners for the event named eventName.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
Adds the listener function to the end of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple
times.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The
emitter.prependListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
Adds a one-time listener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The
emitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
New interface to prepare for sending a message. Use this instead of Conversation.sendMessage.
A MessageBuilder to help set all message sending options.
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple
times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
The name of the event.
The callback function
Adds a one-time listener function for the event named eventName to the
beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
The name of the event.
The callback function
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
OptionaleventName: string | symbolRemoves the specified listener from the listener array for the event named
eventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener() must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any
removeListener() or removeAllListeners() calls after emitting and
before the last listener finishes execution will not remove them from
emit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Because listeners are managed using an internal array, calling this will
change the position indexes of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single
event (as in the example below), removeListener() will remove the most
recently added instance. In the example the once('ping')
listener is removed:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
Remove a participant from the conversation. When a string is passed as the argument, it will assume that the string is an identity or SID.
Identity, SID or the participant object to remove.
Send a message to the conversation.
Message body for the text message,
FormData or SendMediaOptions for media content. Sending FormData
is supported only with the browser engine.
OptionalmessageAttributes: JSONValueAttributes for the message.
OptionalemailOptions: SendEmailOptionsEmail options for the message.
Index of the new message.
Set last read message index of the conversation to the index of the last known message.
Resulting unread messages count in the conversation.
Set all messages in the conversation unread.
New count of unread messages after this update.
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to
Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Set user notification level for this conversation.
New user notification level.
Send a notification to the server indicating that this client is currently typing in this conversation. Typing ended notification is sent after a while automatically, but by calling this method again you ensure that typing ended is not received.
Update the attributes of the conversation.
New attributes.
Update the friendly name of the conversation.
New friendly name.
Set the last read message index to the current read horizon.
Message index to set as last read. If null is provided, then the behavior is identical to Conversation.setAllMessagesUnread.
New count of unread messages after this update.
Update the unique name of the conversation.
New unique name for the conversation. Setting unique name to null removes it.
A conversation represents communication between multiple Conversations clients.