@ably/chat - v1.3.0
    Preparing search index...

    Interface TypingSetEvent

    Represents a change in the state of current typers.

    interface TypingSetEvent {
        change: { clientId: string; type: TypingEventType; userClaim?: string };
        currentlyTyping: Set<string>;
        currentTypers: TypingMember[];
        type: SetChanged;
    }
    Index

    Properties

    change currentlyTyping currentTypers type

    Properties

    change: { clientId: string; type: TypingEventType; userClaim?: string }

    Represents the change that resulted in the new set of typers.

    Type Declaration

    • clientId: string

      The client ID of the user who stopped/started typing.

    • type: TypingEventType

      Type of the change.

    • OptionaluserClaim?: string

      The user claim attached to this typing event by the server. This is set automatically by the server when a JWT contains a matching ably.room.<roomName> claim.

    currentlyTyping: Set<string>

    The set of clientIds that are currently typing.

    Use currentTypers instead, which includes metadata such as user claims.

    currentTypers: TypingMember[]

    The set of users currently typing, with associated metadata.

    type: SetChanged

    The type of the event.

    Settings

    Member Visibility

    On This Page

    Properties