@talkjs/core 1.6.2 → 1.6.3

package/dist/talkSession.d.ts

@@ -337,6 +337,8 @@ export declare interface ConversationRef {
      * Note that `Participant` is not the same as `User`.
      * A `Participant` represents a user's settings related to a specific conversation.
      *
+     * Calling this method multiple times with the same ID reuses the same {@link ParticipantRef} object.
+     *
      * Calling {@link ConversationRef.createIfNotExists|ConversationRef.createIfNotExists} or {@link ConversationRef.set|ConversationRef.set} will automatically add the current user as a participant.
      *
      * @example To add "Alice" to the conversation "Cats"
@@ -364,6 +366,9 @@ export declare interface ConversationRef {
      *
      * @remarks
      * Use this if you need to fetch, delete, or edit a specific message in this conversation, and you know its message ID.
+     *
+     * Calling this method multiple times with the same ID reuses the same {@link MessageRef} object.
+     *
      * To fetch the most recent messages in this conversation, use {@link ConversationRef.subscribeMessages} instead.
      * To send a message, use {@link ConversationRef.send}.
      *
@@ -1293,6 +1298,8 @@ export declare interface MessageRef {
      * If you call `.reaction` with an invalid emoji, it will still succeed and you will still get a `ReactionRef`.
      * However, the TalkJS server will reject any calls that use an invalid emoji.
      *
+     * Calling this method multiple times with the same emoji reuses the same {@link ReactionRef} object.
+     *
      * In the future, this will also be used to fetch a full list of people who used that specific reaction on the message.
      *
      * @example Reacting to the message with a Unicode emoji
@@ -2200,9 +2207,12 @@ export declare interface TalkSession {
      *
      * @remarks
      * This is the entry-point for all operations that affect a user globally, such as editing their name.
+     *
+     * Calling this method multiple times with the same ID reuses the same {@link UserRef} object.
+     *
      * For operations related to a user's participation in a conversation, do: `session.conversation(<convId>).participant(<userId>)`
      *
-     * @see {@link Session.currentUser} which is a short-hand for `session.user(session.me.id)`.
+     * @see {@link Session.currentUser} which is a short-hand for `session.user(meId)`.
      *
      * @example Initialising a user
      * ```
@@ -2232,6 +2242,8 @@ export declare interface TalkSession {
      * This is the entry-point for all conversation-related operations.
      * This includes operations affecting conversation attributes, but also anything related to messages and participants.
      *
+     * Calling this method multiple times with the same ID reuses the same {@link ConversationRef} object.
+     *
      * @example Ensure that the conversation exists and you are a participant
      * ```
      * session.conversation("test").createIfNotExists();