在线状态事件通知

  • Flutter

更新时间

了解如何在实时消息 RTM 中在线状态事件通知,包括适用场景、配置步骤、实现要点和注意事项。

添加事件监听

接收 Presence 事件通知,你需要实现事件监听程序,详见事件监听。除此之外,你需要在订阅或加入频道时将 withPresence 参数设置成 true。PresenceEvent 数据结构包含以下属性:

参数描述
typePresence 事件类型。详见 RtmPresenceEventType。
channelType频道类型,可能是 Message Channel 或 Stream Channel。
channelName事件发生的频道名称。
publisher触发此事件的用户 ID。
stateItems用户临时状态信息列表,remoteStateChanged 事件发生时有效。
intervalInterval 模式下,当前频道在上一个周期内用户加入、离开、超时、状态变更等事件通知的聚合增量信息。
snapshot快照详情。用户首次加入或订阅频道触发了 snapshot 事件时有效。
timestamp事件触发时间戳。
表格内容超出当前宽度,可横向滚动查看更多列。

事件通知类型

Presence 事件通知有七种类型,它们分别是:

枚举值描述
snapshot1: 用户第一次订阅或加入频道时触发,本地用户会收到此类事件通知。
interval2: 当频道内人数达到设定值后,频道内的事件通知将由实时通知转为定时通知。
remoteJoinChannel3: 当用户订阅或加入频道时触发,频道中的其他人会收到此类通知。
remoteLeaveChannel4: 当用户取消订阅或离开频道时触发,频道中的其他人会收到此类通知。
remoteTimeout5: 当用户掉线超时时触发,频道中的其他人会收到此类通知。
remoteStateChanged6: 当用户临时状态数据发生变更时触发,频道中的其他人会收到此类通知。
errorOutOfService7: 用户加入频道时未启用 Presence,本地用户会收到此类事件通知。
表格内容超出当前宽度,可横向滚动查看更多列。

事件通知模式

实时通知模式

如果频道中的在线人数小于实时通知最大人数参数设定的值(默认值为 50),则 Presence 事件通知处于实时通知模式。在此模式下,remoteJoinChannel、remoteLeaveChannel、remoteTimeout、remoteStateChanged 事件在触发时会立即发送到客户端。

Dart
{
    type: RtmPresenceEventType.remoteJoinChannel,
    channelType: RtmChannelType.message,
    channelName: 'chat_room',
    publisher: 'Tony',
    stateItems: [],
    interval: [],
    snapshot: [],
    timestamp: 1710487149497,
}

定时通知模式

当频道中的在线人数超过实时通知最大人数的值时,频道会进入定时通知模式。在这种模式下,remoteJoinChannel、remoteLeaveChannel、remoteTimeout、remoteStateChanged 事件会被 interval 事件代替,并以一定的时间间隔发送给频道中所有用户。

Dart
{
    type : RtmPresenceEventType.interval,
    channelType : RtmChannelType.message,,
    channelName : 'chat_room',
    publisher : 'Tony',
    interval : {
        joinUserList : {users:['Tony','Lily']},
        leaveUserList :{users:['Jason']},
        timeoutUserList : {users:['Wang']},
        userStateList : [
            {
                userId : 'Harvard',
                states :  [{ key: 'mic', value : 'on'},{ key: 'mode', value : 'happy'}],
            },
            {
                userId : 'Harvard',
                states :  [{ key: 'mic', value : 'off'},{ key: 'mode', value : 'sad'}],
            }
        ]
    }
}