Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroupStore

The GroupStore class provides abilities related to breakout rooms.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

groupDetails

groupDetails: Map<string, GroupDetail>

Details of groups

state

state: GroupState

The current state of grouping

Accessors

currentSubRoom

  • get currentSubRoom(): undefined | string

  • The current group

    Returns undefined | string

groupUuidByUserUuid

  • get groupUuidByUserUuid(): Map<string, string>

  • The mapping relation between the group ID and the user ID

    Returns Map<string, string>

userByUuid

  • The map data by userUuid

    Returns Map<string, GroupUser>

Methods

acceptGroupInvite

  • acceptGroupInvite(groupUuid: string): Promise<void>

  • Accepts the invitation of joining a group

    Parameters

    • groupUuid: string

      The group ID

    Returns Promise<void>

addGroups

  • addGroups(groupDetails: (GroupDetail & { groupUuid?: string })[], inProgress?: boolean): Promise<void>

  • Creates a group

    Parameters

    • groupDetails: (GroupDetail & { groupUuid?: string })[]
    • Optional inProgress: boolean

    Returns Promise<void>

broadcastMessage

  • broadcastMessage(messageText: string): void

  • Sends a broadcast message

    Parameters

    • messageText: string

      The message text

    Returns void

joinSubRoom

  • joinSubRoom(groupUuid: string): void

  • Joins a group

    Parameters

    • groupUuid: string

      The group ID

    Returns void

leaveSubRoom

  • leaveSubRoom(): void

  • Leaves the group

    Returns void

moveIntoSubRoom

  • moveIntoSubRoom(fromGroupUuid: string, toGroupUuid: string): void

  • A user moves from a group to another group

    Parameters

    • fromGroupUuid: string

      The ID of the group from which the user is

    • toGroupUuid: string

      The ID of the group to which the user moves

    Returns void

moveUsersToGroup

  • moveUsersToGroup(fromGroupUuid: string, toGroupUuid: string, users: string[]): Promise<void>

  • Moves users from a group to another group

    Parameters

    • fromGroupUuid: string

      The ID of the group from which the users are

    • toGroupUuid: string

      The ID of the group to which the users are moved

    • users: string[]

      A list of user IDs

    Returns Promise<void>

rejectGroupInvite

  • rejectGroupInvite(groupUuid: string): Promise<void>

  • Rejects the invitation of joining a group

    Parameters

    • groupUuid: string

      The group ID

    Returns Promise<void>

removeGroupUsers

  • removeGroupUsers(fromGroupUuid: string, users: string[]): Promise<void>

  • Removes users from a group

    Parameters

    • fromGroupUuid: string

      The group ID

    • users: string[]

      A list of user IDs

    Returns Promise<void>

removeGroups

  • removeGroups(groups: string[]): Promise<void>

  • Removes groups

    Parameters

    • groups: string[]

      A list of group IDs

    Returns Promise<void>

startGroup

  • startGroup(groupDetails: GroupDetail[], syncBoardScenes?: boolean): Promise<void>

  • Starts the breakout session

    Parameters

    • groupDetails: GroupDetail[]

      An array of the grouping options

    • Optional syncBoardScenes: boolean

    Returns Promise<void>

stopGroup

  • stopGroup(): Promise<void>

  • Stops the breakout session

    Returns Promise<void>

updateGroupInfo

  • updateGroupInfo(groups: PatchGroup[]): Promise<void>

  • Updates the grouping options

    Parameters

    • groups: PatchGroup[]

      An array of the grouping options

    Returns Promise<void>

updateGroupUsers

  • updateGroupUsers(patches: PatchGroup[], sendInvitation?: boolean): Promise<void>

  • Updates the grouping options

    Parameters

    • patches: PatchGroup[]

      The update options

    • Optional sendInvitation: boolean

      Whether to send an invitation

    Returns Promise<void>