nim.super_team.NIMSuperTeam

Class: NIMSuperTeam

nim/super_team.NIMSuperTeam

Hierarchy

• EventEmitter<NIMSuperTeamEvents>

  ↳ NIMSuperTeam

Table of contents

Methods

• eventNames
• listeners
• listenerCount
• emit
• on
• addListener
• once
• removeListener
• off
• removeAllListeners
• initEventHandlers
• inviteAsync
• kickAsync
• leaveAsync
• updateSuperTeamInfoAsync
• applyJoinAsync
• passJoinApplyAsync
• rejectJoinApplyAsync
• addManagersAsync
• removeManagersAsync
• transferTeamAsync
• updateMyPropertyAsync
• updateOtherNickAsync
• acceptInvitationAsync
• rejectInvitationAsync
• queryAllMySuperTeamsAsync
• queryAllMySuperTeamsInfoAsync
• queryMyAllMemberInfosAsync
• querySuperTeamMembersAsync
• querySuperTeamMemberAsync
• querySuperTeamInfoAsync
• querySuperTeamInfoOnlineAsync
• muteMemberAsync
• muteAsync
• querySuperTeamsInfoByKeywordAsync

Properties

• team

Constructors

• constructor

Methods

eventNames

▸ eventNames(): "superTeamEvent"[]

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

Returns

"superTeamEvent"[]

Inherited from

EventEmitter.eventNames

Defined in

node_modules/eventemitter3/index.d.ts:15

---

listeners

▸ listeners<T>(event): (...args: ArgumentMap<NIMSuperTeamEvents>[Extract<T, "superTeamEvent">]) => void[]

Return the listeners registered for a given event.

Type parameters

Name	Type
T	extends "superTeamEvent"

Parameters

Name	Type
event	T

Returns

(...args: ArgumentMap<NIMSuperTeamEvents>[Extract<T, "superTeamEvent">]) => 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	"superTeamEvent"

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 "superTeamEvent"

Parameters

Name	Type
event	T
...args	ArgumentMap<NIMSuperTeamEvents>[Extract<T, "superTeamEvent">]

Returns

boolean

Inherited from

EventEmitter.emit

Defined in

node_modules/eventemitter3/index.d.ts:32

---

on

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

Add a listener for a given event.

Type parameters

Name	Type
T	extends "superTeamEvent"

Parameters

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

Returns

NIMSuperTeam

Inherited from

EventEmitter.on

Defined in

node_modules/eventemitter3/index.d.ts:40

---

addListener

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

Type parameters

Name	Type
T	extends "superTeamEvent"

Parameters

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

Returns

NIMSuperTeam

Inherited from

EventEmitter.addListener

Defined in

node_modules/eventemitter3/index.d.ts:45

---

once

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

Add a one-time listener for a given event.

Type parameters

Name	Type
T	extends "superTeamEvent"

Parameters

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

Returns

NIMSuperTeam

Inherited from

EventEmitter.once

Defined in

node_modules/eventemitter3/index.d.ts:54

---

removeListener

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

Remove the listeners of a given event.

Type parameters

Name	Type
T	extends "superTeamEvent"

Parameters

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

Returns

NIMSuperTeam

Inherited from

EventEmitter.removeListener

Defined in

node_modules/eventemitter3/index.d.ts:63

---

off

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

Type parameters

Name	Type
T	extends "superTeamEvent"

Parameters

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

Returns

NIMSuperTeam

Inherited from

EventEmitter.off

Defined in

node_modules/eventemitter3/index.d.ts:69

---

removeAllListeners

▸ removeAllListeners(event?): NIMSuperTeam

Remove all listeners, or those of the specified event.

Parameters

Name	Type
event?	"superTeamEvent"

Returns

NIMSuperTeam

Inherited from

EventEmitter.removeAllListeners

Defined in

node_modules/eventemitter3/index.d.ts:79

---

initEventHandlers

▸ initEventHandlers(): void

注册全局回调

Returns

void

Defined in

ts/nim/super_team.ts:30

---

inviteAsync

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

邀请

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 | SuperTeamEventCallback	邀请的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:52

---

kickAsync

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

踢人

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:97

---

leaveAsync

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

离开群

Note

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

Parameters

Name	Type	Description
tid	string	群组id
cb	null | SuperTeamEventCallback	离开群的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:131

---

updateSuperTeamInfoAsync

▸ updateSuperTeamInfoAsync(tid, info, cb, jsonExtension): Promise<null | [SuperTeamEvent]>

更新群信息

Note

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

Parameters

Name	Type	Description
tid	string	群组id
info	SuperTeamInfo	-
cb	null | SuperTeamEventCallback	更新群信息的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:163

---

applyJoinAsync

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

申请入群

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:200

---

passJoinApplyAsync

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

同意入群申请

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:237

---

rejectJoinApplyAsync

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

拒绝入群申请

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:273

---

addManagersAsync

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

添加管理员

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:314

---

removeManagersAsync

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

删除管理员

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:348

---

transferTeamAsync

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

移交群主

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:384

---

updateMyPropertyAsync

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

更新自己的群属性

Note

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

Parameters

Name	Type	Description
prop	SuperTeamMemberProperty	群成员属性
cb	null | SuperTeamEventCallback	更新自己的群属性的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:423

---

updateOtherNickAsync

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

修改别人的群昵称

Note

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

Parameters

Name	Type	Description
prop	SuperTeamMemberProperty	群成员属性
cb	null | SuperTeamEventCallback	修改别人的群昵称的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:456

---

acceptInvitationAsync

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

接受邀请

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:489

---

rejectInvitationAsync

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

拒绝邀请

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:524

---

queryAllMySuperTeamsAsync

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

查询所有群

Parameters

Name	Type	Description
cb	null | QueryAllMySuperTeamsCallback	查询所有群的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<[number, string[]]>

void 无返回值

Defined in

ts/nim/super_team.ts:556

---

queryAllMySuperTeamsInfoAsync

▸ queryAllMySuperTeamsInfoAsync(cb, jsonExtension): Promise<[number, SuperTeamInfo[]]>

查询所有群信息

Parameters

Name	Type	Description
cb	null | QueryAllMySuperTeamsInfoCallback	查询所有群信息的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<[number, SuperTeamInfo[]]>

void 无返回值

Defined in

ts/nim/super_team.ts:572

---

queryMyAllMemberInfosAsync

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

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

Parameters

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

Returns

Promise<[number, SuperTeamMemberProperty[]]>

void 无返回值

Defined in

ts/nim/super_team.ts:588

---

querySuperTeamMembersAsync

▸ querySuperTeamMembersAsync(tid, cb, jsonExtension): Promise<null | [number, string, number, SuperTeamMemberProperty[]]>

查询群成员

Note

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

Parameters

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

Returns

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

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

Defined in

ts/nim/super_team.ts:611

---

querySuperTeamMemberAsync

▸ querySuperTeamMemberAsync(tid, id, cb, jsonExtension): Promise<[SuperTeamMemberProperty]>

查询(单个)群成员信息

Parameters

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

Returns

Promise<[SuperTeamMemberProperty]>

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

Defined in

ts/nim/super_team.ts:641

---

querySuperTeamInfoAsync

▸ querySuperTeamInfoAsync(tid, cb, jsonExtension): Promise<null | [string, SuperTeamInfo]>

查询群信息

Parameters

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

Returns

Promise<null | [string, SuperTeamInfo]>

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

Defined in

ts/nim/super_team.ts:663

---

querySuperTeamInfoOnlineAsync

▸ querySuperTeamInfoOnlineAsync(tid, cb, jsonExtension): Promise<null | [SuperTeamEvent]>

获取群信息（从服务器获取）

Note

200:成功
803:群不存在

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:693

---

muteMemberAsync

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

禁言/解除禁言

Note

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

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:728

---

muteAsync

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

群禁言/解除群禁言

Note

200:成功
414:参数错误

Parameters

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

Returns

Promise<null | [SuperTeamEvent]>

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

Defined in

ts/nim/super_team.ts:767

---

querySuperTeamsInfoByKeywordAsync

▸ querySuperTeamsInfoByKeywordAsync(keyword, cb, jsonExtension): Promise<[number, SuperTeamInfo[]]>

查询所有群信息

Parameters

Name	Type	Description
keyword	string	要查询的关键字
cb	null | QueryAllMySuperTeamsInfoCallback	查询所有群信息的回调函数
jsonExtension	string	json扩展参数（备用，目前不需要）

Returns

Promise<[number, SuperTeamInfo[]]>

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

Defined in

ts/nim/super_team.ts:793

Properties

team

• team: NIMSuperTeamAPI

Defined in

ts/nim/super_team.ts:23

Constructors

constructor

• new NIMSuperTeam()

Overrides

EventEmitter<NIMSuperTeamEvents&gt;.constructor

Defined in

ts/nim/super_team.ts:24