-
Notifications
You must be signed in to change notification settings - Fork 2
nim.team.NIMTeam
nim/team.NIMTeam
-
EventEmitter<NIMTeamEvents>↳
NIMTeam
- eventNames
- listeners
- listenerCount
- emit
- on
- addListener
- once
- removeListener
- off
- removeAllListeners
- initEventHandlers
- createTeamAsync
- inviteAsync
- kickAsync
- leaveAsync
- dismissAsync
- updateTeamInfoAsync
- applyJoinAsync
- passJoinApplyAsync
- rejectJoinApplyAsync
- addManagersAsync
- removeManagersAsync
- transferTeamAsync
- updateMyPropertyAsync
- updateOtherNickAsync
- acceptInvitationAsync
- rejectInvitationAsync
- queryAllMyTeamsAsync
- queryAllMyTeamsInfoAsync
- queryMyAllMemberInfosAsync
- queryTeamMembersAsync
- queryTeamMemberAsync
- queryTeamInfoAsync
- queryTeamInfoOnlineAsync
- muteMemberAsync
- queryMuteListOnlineAsync
- muteAsync
- teamMsgAckRead
- teamMsgQueryUnreadList
- queryTeamMembersInvitor
- queryTeamInfoByKeywordAsync
- updateTInfoLocal
- getTeamInfoBatchTrans
- getTeaminfoList
▸ eventNames(): "teamEvent"[]
Return an array listing the events for which the emitter has registered listeners.
"teamEvent"[]
EventEmitter.eventNames
▸ listeners<T>(event): (...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void[]
Return the listeners registered for a given event.
| Name | Type |
|---|---|
T |
extends "teamEvent"
|
| Name | Type |
|---|---|
event |
T |
(...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void[]
EventEmitter.listeners
▸ listenerCount(event): number
Return the number of listeners listening to a given event.
| Name | Type |
|---|---|
event |
"teamEvent" |
number
EventEmitter.listenerCount
▸ emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
| Name | Type |
|---|---|
T |
extends "teamEvent"
|
| Name | Type |
|---|---|
event |
T |
...args |
ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">] |
boolean
EventEmitter.emit
▸ on<T>(event, fn, context?): NIMTeam
Add a listener for a given event.
| Name | Type |
|---|---|
T |
extends "teamEvent"
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
|
context? |
any |
EventEmitter.on
▸ addListener<T>(event, fn, context?): NIMTeam
| Name | Type |
|---|---|
T |
extends "teamEvent"
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
|
context? |
any |
EventEmitter.addListener
▸ once<T>(event, fn, context?): NIMTeam
Add a one-time listener for a given event.
| Name | Type |
|---|---|
T |
extends "teamEvent"
|
| Name | Type |
|---|---|
event |
T |
fn |
(...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
|
context? |
any |
EventEmitter.once
▸ removeListener<T>(event, fn?, context?, once?): NIMTeam
Remove the listeners of a given event.
| Name | Type |
|---|---|
T |
extends "teamEvent"
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.removeListener
▸ off<T>(event, fn?, context?, once?): NIMTeam
| Name | Type |
|---|---|
T |
extends "teamEvent"
|
| Name | Type |
|---|---|
event |
T |
fn? |
(...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
|
context? |
any |
once? |
boolean |
EventEmitter.off
▸ removeAllListeners(event?): NIMTeam
Remove all listeners, or those of the specified event.
| Name | Type |
|---|---|
event? |
"teamEvent" |
EventEmitter.removeAllListeners
▸ initEventHandlers(): void
注册全局回调
void
▸ createTeamAsync(info, ids, invitationPostscript, cb, jsonExtension): boolean
创建群组
Note
200:成功 810:如果创建的是高级群，返回810表示邀请成功并带上tinfo 414:成员不足 801:成员数超限制 404:成员中有非法用户
| Name | Type | Description |
|---|---|---|
info |
TeamInfo |
- |
ids |
string[] |
邀请对象id |
invitationPostscript |
string |
- |
cb |
TeamEventCallback |
群通知的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ inviteAsync(tid, ids, invitationPostscript, invitationAttachment, cb, jsonExtension): boolean
邀请
Note
200:成功 810:如果是高级群，返回810表示邀请成功并带上timetag 404:非法用户 801:群人数超限 802:没有权限 803:群不存在
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
ids |
string[] |
邀请对象id |
invitationPostscript |
string |
- |
invitationAttachment |
string |
- |
cb |
TeamEventCallback |
邀请的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ kickAsync(tid, ids, cb, jsonExtension): boolean
踢人
Note
200:成功 403:无超大群功能 414:踢人数量超限 802:群人数超限、不能踢自己 803:群不存在 804:用户不在群里面
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
ids |
string[] |
被踢对象id |
cb |
TeamEventCallback |
踢人的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ leaveAsync(tid, cb, jsonExtension): boolean
离开群
Note
200:成功 403:无超大群功能 802:没有群权限、群主不能退群 803:群不存在 804:用户不在群里
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
cb |
TeamEventCallback |
离开群的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ dismissAsync(tid, cb, jsonExtension): boolean
解散群
Note
200:成功 802:没有权限 803:群不存在
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
cb |
TeamEventCallback |
解散群的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ updateTeamInfoAsync(tid, info, cb, jsonExtension): boolean
更新群信息
Note
200:成功 802:没有权限 803:群不存在
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
info |
TeamInfo |
- |
cb |
TeamEventCallback |
更新群信息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ applyJoinAsync(tid, reason, cb, jsonExtension): boolean
申请入群
Note
200:成功 802:群验证方式为拒绝所有人申请 808:申请成功，等待验证 809:已经在群里 801:人数限制 803:群不存在 805:群类型不对
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
reason |
string |
附言 |
cb |
TeamEventCallback |
申请入群的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ passJoinApplyAsync(tid, applicantId, cb, jsonExtension): boolean
同意入群申请
Note
200:成功 509:操作已失效 809:已经在群里 801:人数限制 802:没有权限 803:群不存在 805:群类型不对
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
applicantId |
string |
- |
cb |
TeamEventCallback |
同意入群申请的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ rejectJoinApplyAsync(tid, applicantId, reason, cb, jsonExtension): boolean
拒绝入群申请
Note
200:成功，如果用户处于申请状态则会通知申请用户被拒绝 509:操作已失效 802:没有权限 803:群不存在 805:群类型不对
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
applicantId |
string |
- |
reason |
string |
附言 |
cb |
TeamEventCallback |
拒绝入群申请的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ addManagersAsync(tid, ids, cb, jsonExtension): boolean
添加管理员
Note
200:成功 802:没有权限 803:群不存在 805:群类型不对
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
ids |
string[] |
管理员id |
cb |
TeamEventCallback |
添加管理员的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ removeManagersAsync(tid, ids, cb, jsonExtension): boolean
删除管理员
Note
200:成功 802:没有权限 803:群不存在 805:群类型不对
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
ids |
string[] |
管理员id |
cb |
TeamEventCallback |
删除管理员的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ transferTeamAsync(tid, newOwnerId, isLeave, cb, jsonExtension): boolean
移交群主
Note
200:成功 802:没有权限 803:群不存在 805:群类型不对 806:群数量上限
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
newOwnerId |
string |
- |
isLeave |
boolean |
- |
cb |
TeamEventCallback |
移交群主的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ updateMyPropertyAsync(prop, cb, jsonExtension): boolean
更新自己的群属性
Note
200:成功 803:群不存在 804:不在群里 805:群类型不对
| Name | Type | Description |
|---|---|---|
prop |
TeamMemberProperty |
群成员属性 |
cb |
TeamEventCallback |
更新自己的群属性的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ updateOtherNickAsync(prop, cb, jsonExtension): boolean
修改别人的群昵称
Note
200:成功 803:群不存在 804:不在群里 805:群类型不对
| Name | Type | Description |
|---|---|---|
prop |
TeamMemberProperty |
群成员属性 |
cb |
TeamEventCallback |
修改别人的群昵称的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ acceptInvitationAsync(tid, inviterId, cb, jsonExtension): boolean
接受邀请
Note
200:成功 802:没有权限 803:群不存在 805:群类型不对
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
inviterId |
string |
- |
cb |
TeamEventCallback |
接受邀请的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ rejectInvitationAsync(tid, inviterId, reason, cb, jsonExtension): boolean
拒绝邀请
Note
200:成功 802:没有权限 803:群不存在 805:群类型不对
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
inviterId |
string |
- |
reason |
string |
附言 |
cb |
TeamEventCallback |
拒绝邀请的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ queryAllMyTeamsAsync(cb, jsonExtension): void
查询所有群
| Name | Type | Description |
|---|---|---|
cb |
QueryAllMyTeamsCallback |
查询所有群的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
void
void 无返回值
▸ queryAllMyTeamsInfoAsync(cb, jsonExtension): void
查询所有群信息
| Name | Type | Description |
|---|---|---|
cb |
QueryAllMyTeamsInfoCallback |
查询所有群信息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
void
void 无返回值
▸ queryMyAllMemberInfosAsync(cb, jsonExtension): void
查询所有群里我的成员信息（使用场景：获取了所有群列表后，需要查询自己在每个群里自己的成员信息，使用成员信息里的bits字段，可以判断当某个群发来消息后，是否做消息通知）
| Name | Type | Description |
|---|---|---|
cb |
QueryTeamMyAllMemberInfosCallback |
查询所有群里我的成员信息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
void
void 无返回值
▸ queryTeamMembersAsync(tid, cb, jsonExtension): boolean
查询群成员
Note
200:成功 406:没有变化 802:没有权限
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
cb |
QueryTeamMembersCallback |
查询群成员的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ queryTeamMemberAsync(tid, id, cb, jsonExtension): void
查询(单个)群成员信息
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
id |
string |
群成员id |
cb |
QueryTeamMemberCallback |
查询群成员的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
void
boolean 检查参数如果不符合要求则返回失败
▸ queryTeamInfoAsync(tid, cb, jsonExtension): boolean
查询群信息
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
cb |
QueryTeamInfoCallback |
查询群信息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ queryTeamInfoOnlineAsync(tid, cb, jsonExtension): boolean
获取群信息（从服务器获取）
Note
200:成功 803:群不存在
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
cb |
TeamEventCallback |
获取群信息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ muteMemberAsync(tid, member_id, set_mute, cb, jsonExtension): boolean
禁言/解除禁言
Note
200:成功 404:禁言对象不存在 414:参数错误 803:群不存在 802:没有权限
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
member_id |
string |
操作对象id |
set_mute |
boolean |
禁言/解除禁言 |
cb |
TeamEventCallback |
踢人的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ queryMuteListOnlineAsync(tid, cb, jsonExtension): boolean
获取群禁言成员列表
Note
200:成功 802:没有权限 803:群不存在
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
cb |
QueryTeamMembersOnlineCallback |
回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ muteAsync(tid, set_mute, cb, jsonExtension): boolean
群禁言/解除群禁言
Note
200:成功 414:参数错误
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
set_mute |
boolean |
禁言/解除禁言 |
cb |
TeamEventCallback |
踢人的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败.
▸ teamMsgAckRead(tid, msgs, cb, jsonExtension): void
群消息回执
Note
200:成功 414:参数错误
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
msgs |
IMMessage[] |
需要发送消息回执的群消息 |
cb |
TeamMsgAckReadCallback |
回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
void
void 无返回值
▸ teamMsgQueryUnreadList(tid, msg, accids, cb, jsonExtension): void
根据指定 ID 获取群组消息已读未读情况
Note
200:成功 414:参数错误
| Name | Type |
|---|---|
tid |
string |
msg |
IMMessage |
accids |
string[] |
cb |
TeamEventCallback |
jsonExtension |
string |
void
void 无返回值
▸ queryTeamMembersInvitor(tid, members, cb): void
查询群成员的邀请人 accid 由接口 原 TeamQueryTeamMembersInvitor方法
Note
200:成功
| Name | Type | Description |
|---|---|---|
tid |
string |
群组id |
members |
string[] |
要查询 的群成员accid列表 |
cb |
QueryTeamMembersInvitorCallback |
回调函数 |
void
void 无返回值
▸ queryTeamInfoByKeywordAsync(keyword, cb, jsonExtension): boolean
查询群信息
| Name | Type | Description |
|---|---|---|
keyword |
string |
要查询的关键字 |
cb |
QueryTeamsInfoCallback |
查询群信息的回调函数 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
boolean
boolean 检查参数如果不符合要求则返回失败
▸ updateTInfoLocal(infos, cb, jsonExtension): void
更新群信息
| Name | Type | Description |
|---|---|---|
infos |
TeamInfo[] |
- |
cb |
UpdateTInfoLocalCallback |
更新群信息的回调函数,回调中会指明更新成功与失败的群ID |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
void
void
▸ getTeamInfoBatchTrans(cb, time_tag, jsonExtension): void
查询所有群
| Name | Type | Description |
|---|---|---|
cb |
GetTeamInfoBatchSFTransCallback |
查询所有群的回调函数 |
time_tag |
number |
时间戳，没有特殊需求此参数赋0 |
jsonExtension |
string |
json扩展参数（备用，目前不需要） |
void
void 无返回值
▸ getTeaminfoList(tids, cb): void
查询给定的一组群ID详细信息
Note
200:成功 414:参数错误 816:部分成功
| Name | Type | Description |
|---|---|---|
tids |
string[] |
- |
cb |
GetTeamInfoListCallback |
查询给定的一组群ID详细信息的回调模板 |
void
void 无返回值
• team: NIMTeamAPI
• new NIMTeam()
EventEmitter<NIMTeamEvents>.constructor
- chatroom/chatroom
- chatroom_def/chatroom_def
- nim/client
- nim/data_sync
- nim/friend
- nim/global
- nim/msglog
- nim/nos
- nim/online_session
- nim/pass_through_proxy
- nim/plugin
- nim/session
- nim/subscribe_event
- nim/super_team
- nim/sysmsg
- nim/talk
- nim/talkex
- nim/team
- nim/tool
- nim/user
- nim_def/client_def
- nim_def/data_sync_def
- nim_def/doc_trans_def
- nim_def/friend_def
- nim_def/global_def
- nim_def/msglog_def
- nim_def/nos_def
- nim_def/online_session_def
- nim_def/pass_through_proxy_def
- nim_def/plugin_def
- nim_def/session_def
- nim_def/subscribe_event_def
- nim_def/super_team_def
- nim_def/sysmsg_def
- nim_def/talk_def
- nim_def/talkex_def
- nim_def/team_def
- nim_def/tool_def
- nim_def/user_def
- node-nim
- qchat/attachment
- qchat/channel
- qchat/channel_category
- qchat/instance
- qchat/message
- qchat/role
- qchat/server
- qchat/system_notification
- qchat_def/attachment_def
- qchat_def/channel_def
- qchat_def/instance_def
- qchat_def/message_def
- qchat_def/public_def
- qchat_def/role_def
- qchat_def/server_def
- qchat_def/system_notification_def