TalkSession

talkSession.setToken(token): 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.

The new auth token to use.

void

Example 1 Non-refreshable authentication

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

Example 2 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};

talkSession.user(id): UserRef

Get a reference to a user.

The returned UserRef is part of the Data API, which is included in the Chat SDK. This is the entry-point for all Data API operations that affect a user globally, such as editing their name. You can use references to get, edit, and subscribe to your data.

A UserRef for the user with that ID

1const userRef = session.user("test");
2userRef.createIfNotExists({ name: "Alice" });

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

talkSession.conversation(id): ConversationRef

Get a reference to a conversation.

The returned ConversationRef is part of the Data API, which is included in the Chat SDK. You can use references to get, edit, and subscribe to your data.

A ConversationRef for the conversation with that ID

1session.conversation("test").createIfNotExists();

1session.conversation("test").set({ subject: "Power tools" });

1session.conversation("test").set({ notify: false });

1session.conversation("test").send("Hello");

talkSession.subscribeConversations(onSnapshot): ConversationListSubscription

Subscribes to your most recently active conversations.

While the subscription is active, onSnapshot will be called whenever the conversation snapshots change. This includes when you join or leave a conversation, when the conversation attributes change, and when you load more conversations. It also includes when nested data changes, such as when snapshot[0].lastMessage.referencedMessage.sender.name changes. Be careful when doing heavy computation inside onSnapshot, and consider caching the result. onSnapshot is called extremely often. loadedAll is true when snapshot contains all your conversations, and false if you could load more.

The snapshot list is ordered chronologically with the most recently active conversations at the start. The last activity of a conversation is either when the last message was sent or when you joined, whichever is later. In other words, it's the max of lastMessage.createdAt and joinedAt. If you join a new conversation, or you receive a message in a conversation, that conversation will appear at the start of the list.

The snapshot is an empty list if the current user does not exist yet.

Initially, you will be subscribed to the 20 most recently active conversations and any conversations that have activity after you subscribe. Call loadMore to load additional older conversations. This will trigger onSnapshot.

Tip: ConversationSnapshot has a lastMessage property. Whenever you are sent a message, that message will be at snapshot[0].lastMessage. If you just want to react to newly received messages, you can use this instead of calling ConversationRef.subscribeMessages. This is much easier and more efficient.

Remember to call .unsubscribe on the subscription once you are done with it.

talkSession.onError(handler): 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.

A callback that runs whenever the session terminates due to an error.

A subscription object. Call Subscription.unsubscribe() to detach the listener.

talkSession.uploadFile(data, metadata): Promise<FileToken>

Upload 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 calling 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.

A file token that can be used to send the file in a message.

talkSession.uploadImage(data, metadata): Promise<FileToken>

Upload an image with image-specific metadata.

This is a variant of uploadFile used for images.

A file token that can be used to send the image in a message.

talkSession.uploadVideo(data, metadata): Promise<FileToken>

Upload a video with video-specific metadata.

This is a variant of uploadFile used for videos.

A file token that can be used to send the video in a message.

talkSession.uploadAudio(data, metadata): Promise<FileToken>

Upload an audio file with audio-specific metadata.

This is a variant of uploadFile used for audio files.

A file token that can be used to send the audio file in a message.

talkSession.uploadVoice(data, metadata): Promise<FileToken>

Upload a voice recording with voice-specific metadata.

This is a variant of uploadFile used for voice recordings.

A file token that can be used to send the audio file in a message.