模組事件
更新時間:2023-08-11 13:56:39
一、使用者資訊變更
說明: 使用者資訊變更時觸發該事件。
Event 事件: UserEvents.UserInfoChange
回調參數: Object 物件,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
userInfo |
新的使用者資訊 | UserInfoDetail |
範例:
watchCore.user.eventEmitter.on(UserEvents.UserInfoChange, (data) => {
console.log('新的用户信息', data.userInfo);
});
二、任意使用者設定暱稱
說明: 任意使用者設定暱稱後觸發該事件。
Event 事件: UserEvents.UserSetNick
回調參數: Object 物件,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
userId |
使用者 userId | string |
nickname |
新的暱稱 | string |
範例:
watchCore.user.eventEmitter.on(UserEvents.UserSetNick, (data) => {
console.log('该用户的 userId', data.userId);
console.log('该用户的新昵称', data.nickname);
});
三、目前使用者設定暱稱
說明: 呼叫 user.updateUserNick 修改暱稱成功後觸發該事件。
Event 事件: UserEvents.CurrentUserSetNick
回調參數: Object 物件,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
userId |
使用者 userId | string |
nickname |
新的暱稱 | string |
範例:
watchCore.user.eventEmitter.on(UserEvents.CurrentUserSetNick, () => {
toast.success('修改昵称成功');
});
四、設定暱稱失敗
說明: 呼叫 user.updateUserNick 修改暱稱失敗後觸發該事件。
Event 事件: UserEvents.SetNickError
回調參數: Object 物件,詳細類型說明如下
| 屬性名 | 說明 | 類型 |
|---|---|---|
message |
失敗資訊 | string |
範例:
watchCore.user.eventEmitter.on(UserEvents.SetNickError, (data) => {
toast.error('修改昵称失败:' + data.message);
});
五、目前使用者被踢出聊天室
說明: 當管理員或助教踢出目前使用者時觸發該事件。
Event 事件: UserEvents.CurrentUserKicked
範例:
watchCore.user.eventEmitter.on(UserEvents.CurrentUserKicked, () => {
toast.error('你已被踢出');
// TODO:重定向到踢出页
});
