Documentation
Flexible Classroom
Console Agora.io Community Submit ticket
English
search-icon

Flexible Classroom Cloud Service Events

Last updated 2022/05/26 02:46:14

Overview

This page lists all types of events that you can get through the Get classroom events method.

The classroom state changes

When the cmd property of an event is 1, the event indicates the classroom state changes, and the data property contains the following fields:

Parameter Type Description
startTime Number The Unix timestamp (in milliseconds) when the classroom starts, in UTC. This property is available after the state of the classroom changes to "Started".
state Integer The current state of the classroom:
  • 0: Not started.
  • 1: In progress.
  • 2: Ended. Users cannot enter the classroom when the classroom is in the "Ended" state.

Example

{
    "startTime":1611561776588,
    "state":1
}

Receives a room chat message

When the cmd property of an event is 3, the event indicates the server receives a room chat message, and the data contains the following fields:

Parameter Type Description
fromUser Object The user who sends this message. This object contains the following fields:
  • userUuid: String. The user ID.
  • userName: String. The user name.
  • role: Integer. The user role:
    • 1: Teacher.
    • 2: Student.
message String The message.
type Integer The type of the message. Temporarily, you can only set this parameter as 1(text).

Example

{
    "fromUser":{
        "role":"host",
        "userName":"jason",
        "userUuid":"jason1"
    },
    "message":"aa",
    "type":1
}

Users enter or leave the classroom

When cmd is 20, the event indicates that users have entered or left the classroom. data includes the following fields:

Parameter Type Description
total Integer The total number of users who have entered and left the classroom.
onlineUsers Object Array The users who have entered the classroom. This object contains the following fields:
  • userName: String. The user name.
  • userUuid: String. The user ID.
  • role: Integer. The user role:
    • 1: Teacher.
    • 2: Student.
  • changeProperties: Object. The user property.
  • streamUuid: String. The ID of the stream, which is also the uid used when joining an RTC channel.
  • type: Integer, the reasons why the user enters the classroom:
    • 1: The user enters the classroom in a normal way.
    • 2: The user re-enters the classroom.
  • updateTime: Number, the time when the user enters the classroom, Unix timestamp (milliseconds), UTC time.
offlineUsers Object Array The users who have left the classroom. This object contains the following fields:
  • userName: String. The user name.
  • userUuid: String. The user ID.
  • role: Integer. The user role:
    • 1: Teacher.
    • 2: Student.
  • changeProperties: Object. The user property.
  • streamUuid: String. The ID of the stream, which is also the uid used when joining an RTC channel.
  • type: Integer, the reasons why the user leaves the classroom:
    • 1: The user left the classroom on the client, such as leaving the class normally, the application is forcibly closed, or the user is disconnected due to poor network conditions.
    • 2: The user was kicked out of the classroom.
  • updateTime: Number, the time when the user enters or leaves the classroom, Unix timestamp (in milliseconds), UTC time.

Example

{
    "total":3,
    "onlineUsers":[
        {
            "userName":"",
            "userUuid":"",
            "role":"0",
            "userProperties":{  },
            "streamUuid":"",
            "type":1,
            "updateTime":1611561776588
        }
    ],
    "offlineUsers":[
        {
            "userName":"",
            "userUuid":"",
            "role":"0",
            "userProperties":{},
            "streamUuid":"",
            "type":1,
            "updateTime":1611561776588
        }
    ]
}

The recording state changes

When the cmd property of an event is 1001, the event indicates the recording state changes, and the data property contains the following fields:

Parameter Type Description
recordId String This is the unique identifier of a recording session. A recording session starts when you call a method to start recording and ends when you call this method to stop recording. This field is available only when state is 1.
sid String The sid of the Agora Cloud Recording service. This field is available only when state is 1.
resourceId String The resourceId of the Agora Cloud Recording service. This field is available only when state is 1.
state Integer The current recording state:
  • 0: Recording has ended.
  • 1: In recording.
startTime Number The Unix timestamp (in milliseconds) when the recording starts, in UTC. This property is available after the recording state changes to "Started".

Example

{
    "recordId":"xxx",
    "sid":"xxx",
    "resourceId":"xxx",
    "state":1,
    "startTime":1611564500488
}

The number of rewards changes

When the cmd property of an event is 1101, the event indicates the number of rewards changes, and the data property contains the following fields:

Parameter Type Description
rewardDetails Object Array Each object represents the rewards of a user and contains the following fields:
  • userUuid: String. The user ID.
  • changedReward: Integer, the number of rewards that have changed.
  • total: Integer, the total number of rewards.
    		•
    updateTime Number The Unix timestamp (in milliseconds) when the rewards change, in UTC.

    Example:

    {
     "rewardDetails":[ {
            "userUuid":"",
            "changedReward": 1,
            "totalReward": 10
        } ],
       "updateTime":1611564500488
}

    The resources in the classroom changes

    When the cmd property of an event is 1003, the event indicates the resources in the classroom changes, and the data property contains the following fields:

    Parameter Type Description
    Parameter Type Description
    resources Object Array Each object represents a public resource and contains the following fields:
  • resourceUuid: String. The resource ID.
  • resourceName: String, the resource name for display in the classroom.
  • size: Number, the resource size (bytes).
  • url: String, the URL address of the resource.
  • taskUuid: String, the ID of the file conversion task.
  • taskToken: String, the token used by the file conversion task.
  • taskProgress: Object, the progress of the file conversion task.
    		•
    operator Object It contains the following fields:
  • userUuid: String. The user ID.
  • userName: String. The user name.
  • role: integer. The role of the user.
    		•
    action Integer The resource change type:
  • 1: The resource is added or updated.
  • 2: The resource is deleted.
    		•

    Example:

    {
     "resources": [{
            "resourceUuid":"",
            "resourceName": "1",
            "size": 1024,
            "url": "http://xxx.com/ooo",
            "taskUuid": "",
            "taskToken": "",
            "taskProgress": {},
        } ],
      "operator":{
        "role":"1",
        "userName":"jason",
        "userUuid":"jason1"
        },
       "action": 1
}