userid
) information.token
information.classid
) information.scene
, debugjs
, and debugcss
are optional parameters, only needed when defining UI. See Custom UI Integration for more details. debugjs
and debugcss
are used only for the debugging of customized layouts and components, and only accessed via localhost
or 127.0.0.1
. Do not use this parameter for the release stage.lng
, location
, layout
are also optional parameters. Businesses can determine whether they need to be entered. If not, they will use the default value. the layout
parameter is only effective when the classroom layout is set to video plus document layout (videodoc
).Field | Type | Meaning | Remarks | Mandatory | |
userid | string | Username | Yes | | |
classid | string | Classroom ID | Yes | | |
token | string | Backend authentication parameters | Yes | | |
version | string | Version number of the classroom | Select the corresponding version by releasing logs. Note: For the interactive classroom client version, we recommend using 'latest' | Yes | |
scene | string | Scenario name | Used to distinguish different custom layouts, configure via the SetAppCustomContent interface, default is default | No | |
debugjs | string | JS link of the custom defined UI | Access through the custom defined UI integration | No | |
debugcss | string | CSS link of the custom defined UI | Access through the custom defined UI integration | No | |
role | string | Role for entering the classroom, default is empty | Optional parameter supervisor (patrolling/content review), only registered users in the application have the authority | No | |
lng | string | Language parameter, default is zh-CN | Currently supported are zh-CN, en-US | No | |
location | boolean | Whether to report geographical location information | Default false, no reporting | No | |
layout | string | Page layout | Default is top layout (top), currently only effective for video document pattern, support for double row layout (double), right layout (right), left layout (left), three-part layout (three) | No | |
boardColor | string | Whiteboard color | Whiteboard color setting, default is: #182E25, supports Hex format, also supports rgba(0, 0, 0, .3) setting | No | |
back_url | string | Exit Classroom Callback Address | Default is empty. It's the page address that needs to be bounced back when clicking return or exiting the classroom. The parameter needs to be encoded using encodeURIComponent | No | |
https://class.qcloudclass.com/latest/class.html?userid=12345&token=yJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODAwNzQwMjEsImlhdCI6MTY3OTQ2OTIyMSwiaXNzIjoibFpNQ2tvTjNkSGlnVmhhcXJkdFc0cU9JYWpleVh2RWwiLCJzY2hvb2xfaWQiOjM5MjMxOTMsInVzZXJfaWQiOiIyTG9XREU2aHhzOUNCNVhCczZHT1BnVXpweUgifQ.2wzh6eUC4llbbGhchGDOYbDrsdSdymfP3zjLLPjnOII&classid=368507569
userid
in the appended URL matches the teacher's ID (teacherid
) specified in the create classroom, then the current user is a teacher. If it matches the current classroom's assistant's ID (assistantid
), the user is an assistant, otherwise, the user is a student.debugjs
and debugcss
to the link above (these parameters are only used for debugging) as shown below:https://class.qcloudclass.com/latest/class.html?userid=12345&token=yJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODAwNzQwMjEsImlhdCI6MTY3OTQ2OTIyMSwiaXNzIjoibFpNQ2tvTjNkSGlnVmhhcXJkdFc0cU9JYWpleVh2RWwiLCJzY2hvb2xfaWQiOjM5MjMxOTMsInVzZXJfaWQiOiIyTG9XREU2aHhzOUNCNVhCczZHT1BnVXpweUgifQ.2wzh6eUC4llbbGhchGDOYbDrsdSdymfP3zjLLPjnOII&classid=368507569&debugjs=http://localhost:443/demo/dist/myLib.umd.min.js&debugcss=http://localhost:443/demo/dist/myLib.css
scene
parameter to the URL to load the layout and components of the corresponding scene. When dealing with various types of classes and various layouts, the business side can switch scenes according to this parameter, as shown below:http://class.qcloudclass.com/latest/class.html?userid=12345&token=yJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODAwNzQwMjEsImlhdCI6MTY3OTQ2OTIyMSwiaXNzIjoibFpNQ2tvTjNkSGlnVmhhcXJkdFc0cU9JYWpleVh2RWwiLCJzY2hvb2xfaWQiOjM5MjMxOTMsInVzZXJfaWQiOiIyTG9XREU2aHhzOUNCNVhCczZHT1BnVXpweUgifQ.2wzh6eUC4llbbGhchGDOYbDrsdSdymfP3zjLLPjnOII&classid=368507569&scene=default
Was this page helpful?