Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt

Use this file to discover all available pages before exploring further.

Adds an event listener for a specific event. See the Event Reference for all available events.

ā€‹
Signature

client.on<T extends EventName>(event: T, callback: EventCallback<T>): this;

ā€‹
Parameters

ParameterTypeDescriptionRequired
eventEventNameThe name of the event to listen for.Yes
callbackEventCallback<T>The callback function to invoke when the event is emitted.Yes

ā€‹
Returns

this ā€” the client instance, allowing method chaining.

ā€‹
Example

client.on('answered', (session) => {
  console.log('Call answered:', session.id);
});

client.on('error', (error) => {
  console.error('SDK error:', error.message);
});

ā€‹
Type-Safe Event Handling

import type { WebRTCClientEvents } from '@cognigy/click-to-call-sdk';

const handleAnswered: WebRTCClientEvents['answered'] = (session) => {
  console.log('Call answered:', session.id);
};

client.on('answered', handleAnswered);

ā€‹
More Information