Skip to content

nim_def.team_def.NIMTeamAPI

Jump to bottom
Zvicii edited this page Apr 19, 2023 · 4 revisions

Interface: NIMTeamAPI

nim_def/team_def.NIMTeamAPI

Table of contents

Methods

Methods

InitEventHandlers

▸ InitEventHandlers(): void

Returns

void

Defined in

ts/nim_def/team_def.ts:148

CreateTeamAsync

▸ CreateTeamAsync(info, ids, invitationPostscript, cb, jsonExtension): boolean

Parameters

Name Type
info TeamInfo
ids string[]
invitationPostscript string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:150

CreateTeamAsyncEx

▸ CreateTeamAsyncEx(info, ids, invitationPostscript, cb, jsonExtension): boolean

Parameters

Name Type
info TeamInfo
ids string[]
invitationPostscript string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:152

InviteAsync

▸ InviteAsync(tid, ids, invitationPostscript, invitationAttachment, cb, jsonExtension): boolean

Parameters

Name Type
tid string
ids string[]
invitationPostscript string
invitationAttachment string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:154

KickAsync

▸ KickAsync(tid, ids, cb, jsonExtension): boolean

Parameters

Name Type
tid string
ids string[]
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:163

LeaveAsync

▸ LeaveAsync(tid, cb, jsonExtension): boolean

Parameters

Name Type
tid string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:165

DismissAsync

▸ DismissAsync(tid, cb, jsonExtension): boolean

Parameters

Name Type
tid string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:167

UpdateTeamInfoAsync

▸ UpdateTeamInfoAsync(tid, info, cb, jsonExtension): boolean

Parameters

Name Type
tid string
info TeamInfo
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:169

ApplyJoinAsync

▸ ApplyJoinAsync(tid, reason, cb, jsonExtension): boolean

Parameters

Name Type
tid string
reason string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:171

PassJoinApplyAsync

▸ PassJoinApplyAsync(tid, applicantId, cb, jsonExtension): boolean

Parameters

Name Type
tid string
applicantId string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:173

RejectJoinApplyAsync

▸ RejectJoinApplyAsync(tid, applicantId, reason, cb, jsonExtension): boolean

Parameters

Name Type
tid string
applicantId string
reason string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:175

AddManagersAsync

▸ AddManagersAsync(tid, ids, cb, jsonExtension): boolean

Parameters

Name Type
tid string
ids string[]
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:177

RemoveManagersAsync

▸ RemoveManagersAsync(tid, ids, cb, jsonExtension): boolean

Parameters

Name Type
tid string
ids string[]
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:179

TransferTeamAsync

▸ TransferTeamAsync(tid, newOwnerId, isLeave, cb, jsonExtension): boolean

Parameters

Name Type
tid string
newOwnerId string
isLeave boolean
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:181

UpdateMyPropertyAsync

▸ UpdateMyPropertyAsync(prop, cb, jsonExtension): boolean

Parameters

Name Type
prop TeamMemberProperty
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:183

UpdateOtherNickAsync

▸ UpdateOtherNickAsync(prop, cb, jsonExtension): boolean

Parameters

Name Type
prop TeamMemberProperty
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:185

AcceptInvitationAsync

▸ AcceptInvitationAsync(tid, inviterId, cb, jsonExtension): boolean

Parameters

Name Type
tid string
inviterId string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:187

RejectInvitationAsync

▸ RejectInvitationAsync(tid, inviterId, reason, cb, jsonExtension): boolean

Parameters

Name Type
tid string
inviterId string
reason string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:189

QueryAllMyTeamsAsync

▸ QueryAllMyTeamsAsync(cb, jsonExtension): void

Parameters

Name Type
cb null | QueryAllMyTeamsCallback
jsonExtension string

Returns

void

Defined in

ts/nim_def/team_def.ts:191

QueryAllMyTeamsInfoAsync

▸ QueryAllMyTeamsInfoAsync(cb, jsonExtension): void

Parameters

Name Type
cb null | QueryAllMyTeamsInfoCallback
jsonExtension string

Returns

void

Defined in

ts/nim_def/team_def.ts:193

QueryMyAllMemberInfosAsync

▸ QueryMyAllMemberInfosAsync(cb, jsonExtension): void

Parameters

Name Type
cb null | QueryTeamMyAllMemberInfosCallback
jsonExtension string

Returns

void

Defined in

ts/nim_def/team_def.ts:195

QueryTeamMembersAsync

▸ QueryTeamMembersAsync(tid, cb, jsonExtension): boolean

Parameters

Name Type
tid string
cb null | QueryTeamMembersCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:197

QueryTeamMemberAsync

▸ QueryTeamMemberAsync(tid, id, cb, jsonExtension): void

Parameters

Name Type
tid string
id string
cb null | QueryTeamMemberCallback
jsonExtension string

Returns

void

Defined in

ts/nim_def/team_def.ts:199

QueryTeamInfoAsync

▸ QueryTeamInfoAsync(tid, cb, jsonExtension): boolean

Parameters

Name Type
tid string
cb null | QueryTeamInfoCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:201

QueryTeamInfoOnlineAsync

▸ QueryTeamInfoOnlineAsync(tid, cb, jsonExtension): boolean

Parameters

Name Type
tid string
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:203

MuteMemberAsync

▸ MuteMemberAsync(tid, member_id, set_mute, cb, jsonExtension): boolean

Parameters

Name Type
tid string
member_id string
set_mute boolean
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:205

QueryMuteListOnlineAsync

▸ QueryMuteListOnlineAsync(tid, cb, jsonExtension): boolean

Parameters

Name Type
tid string
cb null | QueryTeamMembersOnlineCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:207

MuteAsync

▸ MuteAsync(tid, set_mute, cb, jsonExtension): boolean

Parameters

Name Type
tid string
set_mute boolean
cb null | TeamEventCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:209

TeamMsgAckRead

▸ TeamMsgAckRead(tid, msgs, cb, jsonExtension): void

Parameters

Name Type
tid string
msgs IMMessage[]
cb null | TeamMsgAckReadCallback
jsonExtension string

Returns

void

Defined in

ts/nim_def/team_def.ts:211

TeamMsgQueryUnreadList

▸ TeamMsgQueryUnreadList(tid, msg, accids, cb, jsonExtension): void

Parameters

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

Returns

void

Defined in

ts/nim_def/team_def.ts:213

QueryTeamMembersInvitor

▸ QueryTeamMembersInvitor(tid, members, cb): void

Parameters

Name Type
tid string
members string[]
cb null | QueryTeamMembersInvitorCallback

Returns

void

Defined in

ts/nim_def/team_def.ts:215

QueryTeamInfoByKeywordAsync

▸ QueryTeamInfoByKeywordAsync(keyword, cb, jsonExtension): boolean

Parameters

Name Type
keyword string
cb null | QueryTeamsInfoCallback
jsonExtension string

Returns

boolean

Defined in

ts/nim_def/team_def.ts:217

UpdateTInfoLocal

▸ UpdateTInfoLocal(infos, cb, jsonExtension): void

Parameters

Name Type
infos TeamInfo[]
cb null | UpdateTInfoLocalCallback
jsonExtension string

Returns

void

Defined in

ts/nim_def/team_def.ts:219

GetTeamInfoBatchSFTrans

▸ GetTeamInfoBatchSFTrans(cb, time_tag, jsonExtension): void

Parameters

Name Type
cb null | GetTeamInfoBatchSFTransCallback
time_tag number
jsonExtension string

Returns

void

Defined in

ts/nim_def/team_def.ts:221

GetTeaminfoList

▸ GetTeaminfoList(tids, cb): void

Parameters

Name Type
tids string[]
cb null | GetTeamInfoListCallback

Returns

void

Defined in

ts/nim_def/team_def.ts:223

node-nim

Modules

Clone this wiki locally