matrix-js-sdk
    Preparing search index...

    Interface IRTCNotificationContent

    Interface for org.matrix.msc4075.rtc.notification events. Don't cast event content to this directly. Use parseCallNotificationContent instead to validate the content first.

    interface IRTCNotificationContent {
        lifetime: number;
        "m.call.intent"?: string;
        "m.mentions": IMentions;
        "m.new_content"?: undefined;
        "m.relates_to": {
            event_id: string;
            rel_type: Annotation | Reference | Thread;
        };
        msc4354_sticky_key?: string;
        notification_type?: RTCNotificationType;
        sender_ts: number;
        slot_id: string;
    }

    Hierarchy (View Summary)

    Index
    lifetime m.call.intent? m.mentions m.new_content? m.relates_to msc4354_sticky_key? notification_type? sender_ts slot_id
    lifetime: number

    The time (in milliseconds) that the notification is valid for, measured from sender_ts.

    "m.call.intent"?: string

    Not part of MSC4075 anymore. The initial intent of the calling user.

    "m.mentions": IMentions

    The users targeted by the notification. Must either mention the room or at least one user.

    Optionalm.new_content

    "m.new_content"?: undefined
    "m.relates_to": { event_id: string; rel_type: Annotation | Reference | Thread }
    msc4354_sticky_key?: string

    The sticky key as per MSC4354. Must be equal to slot_id.

    Optional because notifications predating MSC4354 omit it.

    notification_type?: RTCNotificationType

    Not part of MSC4075 anymore. How to present a notification is up to the receiving client.

    sender_ts: number

    The timestamp (in milliseconds since the epoch) at which the sending client created the event.

    slot_id: string

    The state_key of the m.rtc.slot event that the notification refers to.

    Notifications predating this property omit it. parseCallNotificationContent fills it in from the referenced membership event, so the parsed content always carries it.

    Settings
    Member Visibility

    On This Page
    Properties