Suggest Edits

Session

A session represents a TalkJS session. It also authenticates your app with TalkJS.

It is also responsible for creating User and Conversation objects.

appId

: String

Your TalkJS AppId that can be found on the Settings page of your TalkJS dashboard.

enablePushNotifications

: bool

This determines whether the device the user is currently using will be registered by the SDK to receive push notifications.

me

: User

A User object that identifies the currently active user.

token

: String?

A token to authenticate the session with. Pass token if you use standard (non-refreshable) authentication.

tokenFetcher

: TokenFetcherHandler?

Triggered when TalkJS needs a new authentication token. The handler should fetch a new token from your server and return it. Pass tokenFetcher if you use authentication with refreshable tokens.

Deprecated

signature

: String?

The HMAC-SHA256 hash of the current user id, signed with your TalkJS secret key. Pass signature if you use legacy signature-based authentication.

onMessage

: MessageHandler?

Triggered when a message is sent in a conversation the current user is in.

Deprecated

unreads

: Unreads?

This property is deprecated. Use onUnreadsChange instead.

This object can notify you when the amount of unread conversations changes.

onUnreadsChange

: UnreadsChangeHandler?

Triggered when the list of unread conversations changes.

1Session({
2  required String appId,
3  bool? enablePushNotifications = false,
4  String? token,
5  TokenFetcherHandler? tokenFetcher,
6  String? signature,
7  MessageHandler? onMessage,
8  Unreads? unreads,
9  UnreadsChangeHandler? onUnreadsChange,
10});

Creates a TalkJS Session.

1Future<void> destroy();

Invalidates this session.

You cannot use any objects that were created in this session after you destroy it.

If you want to use TalkJS after having called destroy() you must instantiate a new Session instance.

The return value is a Future that can be awaited to be sure that the session has actually been invalidated.

1User getUser({
2  required String id,
3  required String name,
4  List<String>? email,
5  List<String>? phone,
6  String? availabilityText,
7  String? locale,
8  String? photoUrl,
9  String? role,
10  Map<String, String?>? custom,
11  String? welcomeMessage,
12});

Fetches or creates a User.

Use this method to synchronize user data with the TalkJS backend.

The fields id and name are required. A warning will be emitted if role is not specified.

Set email to null if you want to use TalkJS without email fallback.

User

1User getUserById(String id);

Fetches an existing User.

Only use this method if you're sure that a user by the given id already exists in TalkJS (for instance, because you synchronized it via the REST API). Otherwise use the getUser method instead.

User

1Conversation getConversation({
2  required String id,
3  Map<String, String?>? custom,
4  List<String>? welcomeMessages,
5  String? photoUrl,
6  String? subject,
7  Set<Participant> participants = const <Participant>{},
8});

Returns a Conversation object that encapsulates a conversation between me (set as a property of the Session) and zero or more other participants.

The returned Conversation is a reference to a conversation with the given id, that is automatically created or updated with the given fields the first time it is used in a ChatBox.

If conversation synchronization is disabled, pass only the id parameter, and make sure that a conversation with that id already exists.

Conversation

1Future<bool> hasValidCredentials();

Verifies whether the appId is valid.

The return value is a Future of a boolean.

1Future<void> setPushRegistration({
2  Provider? provider,
3  String? pushRegistrationId,
4});

Registers push notifications to the TalkJS backend.

If the provider and pushRegistrationId parameters are not passed, it registers the device's current token on Firebase if it's running on Android and on APNs if it's on iOS.

If passing parameters to this function, both provider and pushRegistrationId must not be null

The return value is a Future that can be awaited to be sure that the communication with the backend actually happened.

1Future<void> unsetPushRegistration({
2  Provider? provider,
3  String? pushRegistrationId,
4});

Unregisters push notifications to the TalkJS backend.

If the provider and pushRegistrationId parameters are not passed, it unregisters the device's current token on Firebase if it's running on Android and on APNs if it's on iOS.

If passing parameters to this function, both provider and pushRegistrationId must not be null

The return value is a Future that can be awaited to be sure that the communication with the backend actually happened.

1Future<void> clearPushRegistrations();

Unregisters all push notification device tokens for the current user

The return value is a Future that can be awaited to be sure that the communication with the backend actually happened.

---

1typedef TokenFetcherHandler = Future<String> Function();

Should return a new authentication token to use.

1typedef MessageHandler = void Function(Message message);

See Message for the callback parameter.