Skip to content

nim.team.NIMTeam

Zvicii edited this page Apr 19, 2023 · 7 revisions

Class: NIMTeam

nim/team.NIMTeam

Hierarchy

Table of contents

Methods

Properties

Constructors

Methods

eventNames

eventNames(): "teamEvent"[]

Return an array listing the events for which the emitter has registered listeners.

Returns

"teamEvent"[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/eventemitter3/index.d.ts:15


listeners

listeners<T>(event): (...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void[]

Return the listeners registered for a given event.

Type parameters

Name Type
T extends "teamEvent"

Parameters

Name Type
event T

Returns

(...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void[]

Inherited from

EventEmitter.listeners

Defined in

node_modules/eventemitter3/index.d.ts:20


listenerCount

listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name Type
event "teamEvent"

Returns

number

Inherited from

EventEmitter.listenerCount

Defined in

node_modules/eventemitter3/index.d.ts:27


emit

emit<T>(event, ...args): boolean

Calls each of the listeners registered for a given event.

Type parameters

Name Type
T extends "teamEvent"

Parameters

Name Type
event T
...args ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/eventemitter3/index.d.ts:32


on

on<T>(event, fn, context?): NIMTeam

Add a listener for a given event.

Type parameters

Name Type
T extends "teamEvent"

Parameters

Name Type
event T
fn (...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
context? any

Returns

NIMTeam

Inherited from

EventEmitter.on

Defined in

node_modules/eventemitter3/index.d.ts:40


addListener

addListener<T>(event, fn, context?): NIMTeam

Type parameters

Name Type
T extends "teamEvent"

Parameters

Name Type
event T
fn (...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
context? any

Returns

NIMTeam

Inherited from

EventEmitter.addListener

Defined in

node_modules/eventemitter3/index.d.ts:45


once

once<T>(event, fn, context?): NIMTeam

Add a one-time listener for a given event.

Type parameters

Name Type
T extends "teamEvent"

Parameters

Name Type
event T
fn (...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
context? any

Returns

NIMTeam

Inherited from

EventEmitter.once

Defined in

node_modules/eventemitter3/index.d.ts:54


removeListener

removeListener<T>(event, fn?, context?, once?): NIMTeam

Remove the listeners of a given event.

Type parameters

Name Type
T extends "teamEvent"

Parameters

Name Type
event T
fn? (...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
context? any
once? boolean

Returns

NIMTeam

Inherited from

EventEmitter.removeListener

Defined in

node_modules/eventemitter3/index.d.ts:63


off

off<T>(event, fn?, context?, once?): NIMTeam

Type parameters

Name Type
T extends "teamEvent"

Parameters

Name Type
event T
fn? (...args: ArgumentMap<NIMTeamEvents>[Extract<T, "teamEvent">]) => void
context? any
once? boolean

Returns

NIMTeam

Inherited from

EventEmitter.off

Defined in

node_modules/eventemitter3/index.d.ts:69


removeAllListeners

removeAllListeners(event?): NIMTeam

Remove all listeners, or those of the specified event.

Parameters

Name Type
event? "teamEvent"

Returns

NIMTeam

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/eventemitter3/index.d.ts:79


initEventHandlers

initEventHandlers(): void

注册全局回调

Returns

void

Defined in

ts/nim/team.ts:39


createTeamAsync

createTeamAsync(info, ids, invitationPostscript, cb, jsonExtension): Promise<null | [TeamEvent]>

创建群组

Deprecated

该接口已过时,请使用 createTeamAsyncEx 创建群组

Note

200:成功
810:如果创建的是高级群,返回810表示邀请成功并带上tinfo
414:成员不足
801:成员数超限制
404:成员中有非法用户

Parameters

Name Type Description
info TeamInfo -
ids string[] 邀请对象id
invitationPostscript string -
cb null | TeamEventCallback 群通知的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:60


createTeamAsyncEx

createTeamAsyncEx(info, ids, invitationPostscript, cb, jsonExtension): Promise<null | [TeamEvent]>

创建群组

Note

200:成功
810:如果创建的是高级群,返回810表示邀请成功并带上tinfo
414:成员不足
801:成员数超限制
404:成员中有非法用户

Parameters

Name Type Description
info TeamInfo -
ids string[] 邀请对象id
invitationPostscript string -
cb null | TeamEventCallback 群通知的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:103


dismissAsync

dismissAsync(tid, cb, jsonExtension): Promise<null | [TeamEvent]>

解散群

Note

200:成功
802:没有权限
803:群不存在

Parameters

Name Type Description
tid string 群组id
cb null | TeamEventCallback 解散群的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:142


inviteAsync

inviteAsync(tid, ids, invitationPostscript, invitationAttachment, cb, jsonExtension): Promise<null | [TeamEvent]>

邀请

Note

200:成功
810:如果是高级群,返回810表示邀请成功并带上timetag
404:非法用户
801:群人数超限
802:没有权限
803:群不存在

Parameters

Name Type Description
tid string 群组id
ids string[] 邀请对象id
invitationPostscript string -
invitationAttachment string -
cb null | TeamEventCallback 邀请的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:179


kickAsync

kickAsync(tid, ids, cb, jsonExtension): Promise<null | [TeamEvent]>

踢人

Note

200:成功
403:无超大群功能
414:踢人数量超限
802:群人数超限、不能踢自己
803:群不存在
804:用户不在群里面

Parameters

Name Type Description
tid string 群组id
ids string[] 被踢对象id
cb null | TeamEventCallback 踢人的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:224


leaveAsync

leaveAsync(tid, cb, jsonExtension): Promise<null | [TeamEvent]>

离开群

Note

200:成功
403:无超大群功能
802:没有群权限、群主不能退群
803:群不存在
804:用户不在群里

Parameters

Name Type Description
tid string 群组id
cb null | TeamEventCallback 离开群的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:258


updateTeamInfoAsync

updateTeamInfoAsync(tid, info, cb, jsonExtension): Promise<null | [TeamEvent]>

更新群信息

Note

200:成功
802:没有群权限、群主不能退群
803:群不存在

Parameters

Name Type Description
tid string 群组id
info TeamInfo -
cb null | TeamEventCallback 更新群信息的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:290


applyJoinAsync

applyJoinAsync(tid, reason, cb, jsonExtension): Promise<null | [TeamEvent]>

申请入群

Note

200:成功
802:群验证方式为拒绝所有人申请
808:申请成功,等待验证
809:已经在群里
801:人数限制
803:群不存在
805:群类型不对

Parameters

Name Type Description
tid string 群组id
reason string 附言
cb null | TeamEventCallback 申请入群的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:327


passJoinApplyAsync

passJoinApplyAsync(tid, applicantId, cb, jsonExtension): Promise<null | [TeamEvent]>

同意入群申请

Note

200:成功
509:操作已失效
809:已经在群里
801:人数限制
802:没有权限
803:群不存在
805:群类型不对

Parameters

Name Type Description
tid string 群组id
applicantId string -
cb null | TeamEventCallback 同意入群申请的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:364


rejectJoinApplyAsync

rejectJoinApplyAsync(tid, applicantId, reason, cb, jsonExtension): Promise<null | [TeamEvent]>

拒绝入群申请

Note

200:成功,如果用户处于申请状态则会通知申请用户被拒绝
509:操作已失效
802:没有权限
803:群不存在
805:群类型不对

Parameters

Name Type Description
tid string 群组id
applicantId string -
reason string 附言
cb null | TeamEventCallback 拒绝入群申请的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:400


addManagersAsync

addManagersAsync(tid, ids, cb, jsonExtension): Promise<null | [TeamEvent]>

添加管理员

Note

200:成功
802:没有权限
803:群不存在
805:群类型不对

Parameters

Name Type Description
tid string 群组id
ids string[] 管理员id
cb null | TeamEventCallback 添加管理员的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:435


removeManagersAsync

removeManagersAsync(tid, ids, cb, jsonExtension): Promise<null | [TeamEvent]>

删除管理员

Note

200:成功
802:没有权限
803:群不存在
805:群类型不对

Parameters

Name Type Description
tid string 群组id
ids string[] 管理员id
cb null | TeamEventCallback 删除管理员的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:469


transferTeamAsync

transferTeamAsync(tid, newOwnerId, isLeave, cb, jsonExtension): Promise<null | [TeamEvent]>

移交群主

Note

200:成功
802:没有权限
803:群不存在
805:群类型不对
806:群数量上限

Parameters

Name Type Description
tid string 群组id
newOwnerId string -
isLeave boolean -
cb null | TeamEventCallback 移交群主的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:505


updateMyPropertyAsync

updateMyPropertyAsync(prop, cb, jsonExtension): Promise<null | [TeamEvent]>

更新自己的群属性

Note

200:成功
803:群不存在
804:不在群里
805:群类型不对

Parameters

Name Type Description
prop TeamMemberProperty 群成员属性
cb null | TeamEventCallback 更新自己的群属性的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:539


updateOtherNickAsync

updateOtherNickAsync(prop, cb, jsonExtension): Promise<null | [TeamEvent]>

修改别人的群昵称

Note

200:成功
802:没有权限
803:群不存在
804:不在群里
805:群类型不对

Parameters

Name Type Description
prop TeamMemberProperty 群成员属性
cb null | TeamEventCallback 修改别人的群昵称的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:572


acceptInvitationAsync

acceptInvitationAsync(tid, inviterId, cb, jsonExtension): Promise<null | [TeamEvent]>

接受邀请

Note

200:成功
802:没有权限
803:群不存在
805:群类型不对

Parameters

Name Type Description
tid string 群组id
inviterId string -
cb null | TeamEventCallback 接受邀请的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:605


rejectInvitationAsync

rejectInvitationAsync(tid, inviterId, reason, cb, jsonExtension): Promise<null | [TeamEvent]>

拒绝邀请

Note

200:成功
802:没有权限
803:群不存在
805:群类型不对

Parameters

Name Type Description
tid string 群组id
inviterId string -
reason string 附言
cb null | TeamEventCallback 拒绝邀请的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:640


queryAllMyTeamsAsync

queryAllMyTeamsAsync(cb, jsonExtension): Promise<[number, string[]]>

查询所有群

Parameters

Name Type Description
cb null | QueryAllMyTeamsCallback 查询所有群的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[number, string[]]>

void 无返回值

Defined in

ts/nim/team.ts:666


queryAllMyTeamsInfoAsync

queryAllMyTeamsInfoAsync(cb, jsonExtension): Promise<[number, TeamInfo[]]>

查询所有群信息

Parameters

Name Type Description
cb null | QueryAllMyTeamsInfoCallback 查询所有群信息的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[number, TeamInfo[]]>

void 无返回值

Defined in

ts/nim/team.ts:682


queryMyAllMemberInfosAsync

queryMyAllMemberInfosAsync(cb, jsonExtension): Promise<[number, TeamMemberProperty[]]>

查询所有群里我的成员信息(使用场景:获取了所有群列表后,需要查询自己在每个群里自己的成员信息,使用成员信息里的bits字段,可以判断当某个群发来消息后,是否做消息通知)

Parameters

Name Type Description
cb null | QueryTeamMyAllMemberInfosCallback 查询所有群里我的成员信息的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[number, TeamMemberProperty[]]>

void 无返回值

Defined in

ts/nim/team.ts:698


queryTeamMembersAsync

queryTeamMembersAsync(tid, cb, jsonExtension): Promise<null | [string, number, TeamMemberProperty[]]>

查询群成员

Note

200:成功
406:没有变化
802:没有权限

Parameters

Name Type Description
tid string 群组id
cb null | QueryTeamMembersCallback 查询群成员的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [string, number, TeamMemberProperty[]]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:721


queryTeamMemberAsync

queryTeamMemberAsync(tid, id, cb, jsonExtension): Promise<[TeamMemberProperty]>

查询(单个)群成员信息

Parameters

Name Type Description
tid string 群组id
id string 群成员id
cb null | QueryTeamMemberCallback 查询群成员的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[TeamMemberProperty]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:751


queryTeamInfoAsync

queryTeamInfoAsync(tid, cb, jsonExtension): Promise<null | [string, TeamInfo]>

查询群信息

Parameters

Name Type Description
tid string 群组id
cb null | QueryTeamInfoCallback 查询群信息的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [string, TeamInfo]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:773


queryTeamInfoOnlineAsync

queryTeamInfoOnlineAsync(tid, cb, jsonExtension): Promise<null | [TeamEvent]>

获取群信息(从服务器获取)

Note

200:成功
803:群不存在

Parameters

Name Type Description
tid string 群组id
cb null | TeamEventCallback 获取群信息的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:803


muteMemberAsync

muteMemberAsync(tid, member_id, set_mute, cb, jsonExtension): Promise<null | [TeamEvent]>

禁言/解除禁言

Note

200:成功
404:禁言对象不存在
414:参数错误
803:群不存在
802:没有权限

Parameters

Name Type Description
tid string 群组id
member_id string 操作对象id
set_mute boolean 禁言/解除禁言
cb null | TeamEventCallback 踢人的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:838


muteAsync

muteAsync(tid, set_mute, cb, jsonExtension): Promise<null | [TeamEvent]>

群禁言/解除群禁言

Note

200:成功
414:参数错误

Parameters

Name Type Description
tid string 群组id
set_mute boolean 禁言/解除禁言
cb null | TeamEventCallback 踢人的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [TeamEvent]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:871


queryMuteListOnlineAsync

queryMuteListOnlineAsync(tid, cb, jsonExtension): Promise<null | [NIMResCode, number, TeamMemberProperty[]]>

获取群禁言成员列表

Note

200:成功
802:没有权限
803:群不存在

Parameters

Name Type Description
tid string 群组id
cb null | QueryTeamMembersOnlineCallback 回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<null | [NIMResCode, number, TeamMemberProperty[]]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:903


teamMsgAckRead

teamMsgAckRead(tid, msgs, cb, jsonExtension): Promise<[string, string[], string[], string[]]>

群消息回执

Note

200:成功
414:参数错误

Parameters

Name Type Description
tid string 群组id
msgs IMMessage[] 需要发送消息回执的群消息
cb null | TeamMsgAckReadCallback 回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[string, string[], string[], string[]]>

void 无返回值

Defined in

ts/nim/team.ts:938


teamMsgQueryUnreadList

teamMsgQueryUnreadList(tid, msg, accids, cb, jsonExtension): Promise<[TeamEvent]>

根据指定 ID 获取群组消息已读未读情况 @param[in] tid 群组id @param[in] msg 群消息 @param[in] accids 要查询的 ID 列表 @param[in] jsonExtension json扩展参数(备用,目前不需要) @param[in] cb 回调函数

Note

200:成功
414:参数错误

Parameters

Name Type
tid string
msg IMMessage
accids string[]
cb null | TeamEventCallback
jsonExtension string

Returns

Promise<[TeamEvent]>

void 无返回值

Defined in

ts/nim/team.ts:972


queryTeamMembersInvitor

queryTeamMembersInvitor(tid, members, cb): Promise<[NIMResCode, number, Map<string, string>]>

查询群成员的邀请人 accid 由接口 原 TeamQueryTeamMembersInvitor方法

Note

200:成功

Parameters

Name Type Description
tid string 群组id
members string[] 要查询 的群成员accid列表
cb null | QueryTeamMembersInvitorCallback 回调函数

Returns

Promise<[NIMResCode, number, Map<string, string>]>

void 无返回值

Defined in

ts/nim/team.ts:999


queryTeamInfoByKeywordAsync

queryTeamInfoByKeywordAsync(keyword, cb, jsonExtension): Promise<[number, TeamInfo[]]>

查询群信息

Parameters

Name Type Description
keyword string 要查询的关键字
cb null | QueryTeamsInfoCallback 查询群信息的回调函数
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[number, TeamInfo[]]>

boolean 检查参数如果不符合要求则返回失败

Defined in

ts/nim/team.ts:1020


updateTInfoLocal

updateTInfoLocal(infos, cb, jsonExtension): Promise<[string[], string[]]>

更新群信息

Parameters

Name Type Description
infos TeamInfo[] -
cb null | UpdateTInfoLocalCallback 更新群信息的回调函数,回调中会指明更新成功与失败的群ID
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[string[], string[]]>

void

Defined in

ts/nim/team.ts:1043


getTeamInfoBatchTrans

getTeamInfoBatchTrans(cb, time_tag, jsonExtension): Promise<[number, TeamInfo[]]>

查询所有群

Parameters

Name Type Description
cb null | GetTeamInfoBatchSFTransCallback 查询所有群的回调函数
time_tag number 时间戳,没有特殊需求此参数赋0
jsonExtension string json扩展参数(备用,目前不需要)

Returns

Promise<[number, TeamInfo[]]>

void 无返回值

Defined in

ts/nim/team.ts:1064


getTeaminfoList

getTeaminfoList(tids, cb): Promise<[NIMResCode, TeamInfo[], string[]]>

查询给定的一组群ID详细信息

Note

200:成功
414:参数错误
816:部分成功

Parameters

Name Type Description
tids string[] -
cb null | GetTeamInfoListCallback 查询给定的一组群ID详细信息的回调模板

Returns

Promise<[NIMResCode, TeamInfo[], string[]]>

void 无返回值

Defined in

ts/nim/team.ts:1090

Properties

team

team: NIMTeamAPI

Defined in

ts/nim/team.ts:32

Constructors

constructor

new NIMTeam()

Overrides

EventEmitter<NIMTeamEvents&gt;.constructor

Defined in

ts/nim/team.ts:33

Clone this wiki locally