TalkSession

1setToken(token: string): void;

Set the auth token to be used on this session (and all other sessions with the same appId and userId). This will immediately reauthenticate the websocket connection to TalkJS, overwriting any previous tokens on the session.

This does not affect any in-progress requests. As long as the new token is valid, your subscriptions will stay active with no gaps or missing data during reauthentication.

Example Non-refreshable authentication

1const session = getTalkSession({
2  appId: '<APP_ID>',
3  userId: '<USER_ID>',
4});
5session.setToken('...');

Example Refreshable authentication

1const session = getTalkSession({
2  appId: '<APP_ID>',
3  userId: '<USER_ID>',
4});
5session.onNeedToken = async () => {
6  const token = await fetchToken();
7  session.setToken(token);
8};

1user(id: string): UserRef;

Returns a reference to the user with the specified ID.

This is the entry-point for all operations that affect a user globally, such as editing their name. For operations related to a user's participation in a conversation, do: session.conversation(<convId>).participant(<userId>).

Example Initialising a user

1const userRef = session.user('<USER_ID>');
2userRef.createIfNotExists({ name: 'Alice' });

Example Subscribing to changes

1const userRef = session.user('<USER_ID>');
2const sub = userRef.subscribe((snapshot) => console.log(snapshot));
3await sub.connected;
4
5// Changing the user's name emits a snapshot and triggers the `console.log`
6await userRef.set({ name: 'Bob' });

1conversation(id: string): ConversationRef;

Returns a reference to the conversation with the specified ID.

This is the entry-point for all conversation-related operations. This includes operations affecting conversation attributes, but also anything related to messages and participants.

Example Ensure that the conversation exists and you are a participant

1session.conversation('<CONV_ID>').createIfNotExists();

Example Set the conversation's subject

1session.conversation('<CONV_ID>').set({ subject: 'Power tools' });

Example Send a message

1session.conversation('<CONV_ID>').send('Hello');

1subscribeConversations(
2  snapshot: ConversationSnapshot[], loadedAll: boolean) => void
3): ConversationListSubscription;

Subscribes to your most recently active conversations.

The subscription is 'windowed'. Initially, this window contains the 20 most recent conversations. Conversations are ordered by last activity. The last activity of a conversation is either joinedAt or lastMessage.createdAt, whichever is higher.

If an older conversation receives a new message, or you are added to a conversation, it will appear at the start of the list. Call loadMore to load additional older conversations.

Whenever Subscription.state.type is "active" and something changes in your conversations, onSnapshot will fire and Subscription.state.latestSnapshot will be updated. loadedAll is true when the snapshot contains all your conversations.

If the current user does not exist yet, the snapshot will be an empty list.

Returns a ConversationListSubscription.

1onError(handler: (error: Error) => void): Subscription;

Attaches a listener which gets called when the TalkSession encounters an unrecoverable error. For example, if the session cannot authenticate, or if you specify an incorrect app ID.

If the session has already terminated, the handler will be called immediately.

1uploadFile(data: Blob, metadata: GenericFileMetadata): Promise<FileToken>;

Uploads a generic file without any additional metadata.

This function does not send any message, it only uploads the file and returns a file token. To send the file in a message, pass the file token in a SendFileBlock when you call ConversationRef.send.

See the documentation for more information about sending files in messages.

If the file is a video, image, audio file, or voice recording, use one of the other functions like uploadImage instead.

1uploadImage(data: Blob, metadata: ImageFileMetadata): Promise<FileToken>;

Uploads an image with image-specific metadata. This is a variant of uploadFile used for images.

1uploadVideo(data: Blob, metadata: VideoFileMetadata): Promise<FileToken>;

Uploads a video with video-specific metadata. This is a variant of uploadFile used for videos.

1uploadAudio(data: Blob, metadata: AudioFileMetadata): Promise<FileToken>;

Uploads an audio file with audio-specific metadata. This is a variant of uploadFile used for audio files.

1uploadVoice(data: Blob, metadata: VoiceFileMetadata): Promise<FileToken>;

Uploads a voice recording with voice-specific metadata. This is a variant of uploadFile used for voice recordings.