Class TeamStore

Mobx 可观察对象，负责管理群组的子 store

Hierarchy

TeamStore

Constructors

constructor

new TeamStore(rootStore, nim, localOptions): TeamStore
Parameters
- rootStore: RootStore
- nim: INimKitCore
- localOptions: LocalOptions
Returns TeamStore

Properties

teams

teams: Map<string, Team> = ...

Methods

acceptTeamInviteActive

acceptTeamInviteActive(options): Promise<void>
接受入群邀请
Parameters
- options: AcceptTeamInviteOptions
  
  options.teamId - 群id
  options.from - 邀请方的帐号
Returns Promise<void>

addTeam

addTeam(teams): void
TeamStore增加群组（TeamStore内部使用，外层不太推荐直接使用）
Parameters
- teams: Team[]
  
  群组
Returns void

addTeamManagersActive

addTeamManagersActive(options): Promise<void>
添加群管理员
Parameters
- options: {
  accounts: string[];
  teamId: string;
  }
  
  options.teamId - 群id
  options.accounts - 群管理员 accid
  - accounts: string[]
  - teamId: string
Returns Promise<void>

applyTeamActive

applyTeamActive(teamId): Promise<void>
申请入群
Parameters
- teamId: string
  
  群id
Returns Promise<void>

createTeamActive

createTeamActive(__namedParameters): Promise<Team>
创建群
Parameters
- __namedParameters: {
      accounts: string[];
      avatar: string;
      ext?: string;
      intro?: string;
      name: string;
  }
  - accounts: string[]
    
    要拉进群的成员的帐号列表
  - avatar: string
    
    群头像
  - Optional ext?: string
    
    群扩展字段
  - Optional intro?: string
    
    群简介
  - name: string
    
    群名称
Returns Promise<Team>

destroy

destroy(): void
销毁TeamStore，会取消群组相关事件监听

Returns void

dismissTeamActive

dismissTeamActive(teamId): Promise<void>
解散群
Parameters
- teamId: string
  
  群id
Returns Promise<void>

getTeamActive

getTeamActive(teamId): Promise<Team>
获取群信息
Parameters
- teamId: string
  
  群id
Returns Promise<Team>

getTeamForceActive

getTeamForceActive(teamId): Promise<Team>
获取群信息（搜索时使用）
Parameters
- teamId: string
  
  群id
Returns Promise<Team>

leaveTeamActive

leaveTeamActive(teamId): Promise<void>
主动退群
Parameters
- teamId: string
  
  群id
Returns Promise<void>

muteTeamActive

muteTeamActive(options): Promise<void>
群禁言
Parameters
- options: MuteTeamOptions
  
  options.teamId - 群id
  options.mute - 是否禁言
Returns Promise<void>

passTeamApplyActive

passTeamApplyActive(options): Promise<void>
通过入群申请
Parameters
- options: PassTeamApplyOptions
  
  options.teamId - 群id
  options.from - 邀请方的帐号
Returns Promise<void>

rejectTeamApplyActive

rejectTeamApplyActive(options): Promise<void>
拒绝入群申请
Parameters
- options: RejectTeamApplyOptions
  
  options.teamId - 群id
  options.from - 邀请方的帐号 options.ps - 附言, 选填, 开发者也可以使用JSON格式的字符串来扩展此内容
Returns Promise<void>

rejectTeamInviteActive

rejectTeamInviteActive(options): Promise<void>
拒绝入群邀请
Parameters
- options: RejectTeamInviteOptions
  
  options.teamId - 群id
  options.from - 邀请方的帐号 options.ps - 附言, 选填, 开发者也可以使用JSON格式的字符串来扩展此内容
Returns Promise<void>

removeTeam

removeTeam(teamIds): void
TeamStore移除群组（TeamStore内部使用，外层不太推荐直接使用）
Parameters
- teamIds: string[]
  
  群id数组
Returns void

removeTeamManagersActive

removeTeamManagersActive(options): Promise<void>
移除群管理员
Parameters
- options: {
  accounts: string[];
  teamId: string;
  }
  
  options.teamId - 群id
  options.accounts - 群管理员 accid
  - accounts: string[]
  - teamId: string
Returns Promise<void>

transferTeamActive

transferTeamActive(__namedParameters): Promise<void>
转让群主
Parameters
- __namedParameters: {
      account: string;
      leave?: boolean;
      teamId: string;
  }
  - account: string
  - Optional leave?: boolean
  - teamId: string
Returns Promise<void>

updateTeam

updateTeam(data): void
TeamStore更新群组（TeamStore内部使用，外层不太推荐直接使用）
Parameters
- data: Partial<Team>[]
  
  群组信息
Returns void

updateTeamActive

updateTeamActive(options): Promise<void>
更新群
Parameters
- options: UpdateTeamInfoOptions
  
  options.teamId - 群id
  options.name - 群名称
  options.avatar - 群头像
  options.announcement - 群公告
  options.joinMode - 群加入方式
  options.beInviteMode - 群被邀请模式
  options.inviteMode - 群邀请模式
  options.updateTeamMode - 群信息修改权限
  options.updateExtMode - manager | all
Returns Promise<void>

Generated using TypeDoc