FCRGroupContext

getGroupInfo

Gets the grouping information.

abstract fun getGroupInfo(): FCREduContextGroupInfo?

Returns

Returns the grouping info object: FCREduContextGroupInfo.

addSubRoomList

Creates sub-rooms.

abstract fun addSubRoomList(
        appId: String,
        roomUuid: String,
        groupWithInProgress: GroupWithInProgress,
        callback: HttpCallback<HttpBaseRes<String>>?
)

Parameter

removeSubRoomList

Removes several sub-rooms.

abstract fun removeSubRoomList(
        appId: String,
        roomUuid: String,
        subRoomList: List<String>,
        callback: HttpCallback<HttpBaseRes<String>>?
)

Parameter

subRoomList: The list of sub-room IDs.

removeAllSubRoomList

Removes all sub-rooms.

abstract fun removeAllSubRooms(
        callback: HttpCallback<HttpBaseRes<String>>?
)

Parameter

getSubRoomList

Gets the sub-room list.

abstract fun getSubRoomList(): AgoraEduContextSubRoomInfo

Returns

If the method call succeeds, the SDK returns the sub-room list: AgoraEduContextSubRoomInfo.

getUserListFrom

Gets the list of users in the specified sub-room.

abstract fun getUserListFrom(subRoomUuid: String): List<String>

Parameter

subRoomUuid: The sub-room ID.

Returns

A list of user IDs.

inviteUserListToSubRoom

Invites users to join sub-rooms.

abstract fun inviteUserListToSubRoom(
        userList: List<String>,
        appId: String,
        roomUuid: String,
        groupUuid: String,
        callback: HttpCallback<HttpBaseRes<String>>?
)

Parameter

userList: A list of user IDs.
subRoomUuid: The sub-room ID.

userListAcceptInvitationToSubRoom

The user accepts the invitation to join a sub-room.

abstract fun userListAcceptInvitationToSubRoom(
        userList: List<String>, subRoomUuid: String,
        callback: HttpCallback<HttpBaseRes<String>>?
)

Parameter

userList: A list of user IDs.
subRoomUuid: The sub-room ID.

userListRejectInvitationToSubRoom

The user rejects the invitation to join a sub-room.

abstract fun userListRemoveFromSubRoom(
        userList: List<String>,
        appId: String,
        roomUuid: String,
        groupUuid: String,
        callback: HttpCallback<HttpBaseRes<String>>?
)

Parameter

userList: A list of user IDs.
subRoomUuid: The sub-room ID.

addUserListToSubRoom

Moves users into a sub-room.

abstract fun addUserListToSubRoom(
        userList: List<String>, subRoomUuid: String,
        callback: HttpCallback<HttpBaseRes<String>>?
)

This method skips the invitation and moves users directly into a sub-room.

Parameter

userList: A list of user IDs.
subRoomUuid: The sub-room ID.

moveUserListToSubRoom

Moves a user from one sub-room to another.

abstract fun moveUserListToSubRoom(
        userList: List<String>, 
        fromSubRoomUuid: String, 
        toSubRoomUuid: String,
        callback: HttpCallback<HttpBaseRes<String>>?
)

Parameter

userList: A list of user IDs.
fromSubRoomUuid: The source sub-room ID.
toSubRoomUuid: The target sub-room ID.