PC端SDK基础接口

设置用户信息

window.WCRClassRoom.setUser(userInfo) 设置登录或者取消登录，userInfo为一个JSON的字符串，格式如下 如果userInfo为""，则代表取消登录 如果userInfo不为空且合法，则代表登录(SDK内部只会记录，此刻不会发起新的登录请求)

key type description
id String 用户唯一ID，必须为无符号int范围内的数字(不能大于21亿)
type String 老师或者学生 “teacher” “student”
name String 用户昵称
token String 用户的token, SDK后台API会通过此接口验证登录
avatar String 用户头像，HTTP连接地址
mobile String 用户手机号
institution_id String 机构号

JSON串示例：

{
    "id": "20160401",
    "type": "teacher",
    "name": "Jeff_Teacher",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyb2xlIjoiMiIsInN1YiI6NDQ0LCJpc ",
    "avatar": "http://www.weclassroom.com/static/res/013d2c8ef3f1a1aa7ecab676e6fc68c6.png",
    "mobile": "15801529000",
    "institution_id": "67",
}

进入教室

window. WCRClassRoom.joinClassRoomWithoutCallback(joininfo) joininfo为JSON字符串，格式如下，指定了进入教室所必须的信息

key type Mandatory description
institutionId int √ 机构ID，由直播云提供(机构后台注册后可拿到)
id String √ 教室ID，必须为无符号int范围内的数字（不能大于21亿，数字转的字符串）
title string √ 课程标题
teacher_id string √ 老师id
scenario string √ 课程类型,
"0" : 一对一
"7" : 小班课
"2" : 大班课
startTime string √ 课程计划开始时间 yyyy-MM-dd hh:mm:ss
endTime String √ 课程计划结束时间yyyy-MM-dd hh:mm:ss
status int √ 该状态和后台定义对齐，端上内部自行做映射处理。
退出重进教室的时候，需要把当前课程状态传入：
CLASS_INVALID = -1, //无效课
CLASS_WAITING = 1, //待上课
CLASS_ONGOING = 2, //在上课
CLASS_FINISHED = 3, //已结束
CLASS_EXPIRE = 4 //已失效
lesson_slide_url String 非必须 普通课件需要：进入教室之后默认打开的课件地址https://zby-oss-foreign.weclassroom.com/lesson/jenkins/light/198/996985/611376/doc.html，
老师端必须配置，为进教室后默认打开的课件
学生端可以通过配置此参数，在开始上课前打开一个log页或欢迎页之类的
lesson_slide_backup_url String数组 非必须 备用课件地址，字符串数组，如："lesson_slide_backup_url": ["https://zby-oss-foreign.weclassroom.com/lesson/jenkins/light/198/996985/611376/doc.html", "https://zby-oss-foreign.weclassroom.com/lesson/jenkins/light/198/996985/558844/doc.html"]
students String 小班课必须 [{id:用户ID,name:用户,avatar:头像,Mobile},{}]students\":[{\"id\":516664575,\"name\":\"洋学生1\",\"avatar\":\"https:\/\/i.weclassroom.com\/nova\/01_imgs\/qw.png\",\"created_at\":1509764050,\"count\":0,\"diamond_count\":0},{\"id\":113305,\"name\":\"洋学生10\",\"avatar\":\"https:\/\/i.weclassroom.com\/nova\/01_imgs\/sz.png\",\"created_at\":1509764050,\"count\":0,\"diamond_count\":0}]
actualStartTime string 课程实际开始上课时间 开始上课后的课程，再次进教室，需要传递此参数yyyy-MM-dd hh:mm:ss格式的字符串
actualEndTime string 课程实际结束时间 已结束的课程，再次进教室，需要传递此参数yyyy-MM-dd hh:mm:ss格式的字符串

Joininfo：进小班课1V1模式的JSON示例：

{
    "id": "1000012",
    "title": "机构测试课",
    "scenario": "0",
    "startTime": "2017-05-12 18:00:00",
    "endTime": "2017-05-12 22:05:00",
    "teacher_name": "Jeff_Teacher",
    "teacher_id": "20160401",
    "institutionId": 79,
    "status": 1,
    "lesson_slide_url": "http://cloudclass-dev.oss-cn-beijing.aliyuncs.com/lesson/jenkins/light/79/0/3314/doc.html"
}

可选接口

序号 接口名称 接口描述 支持用户端
1 Window.WCRClassRoom.getClientVersion() 返回为字符串，当前客户端的版本号 老师端、学生端
2 Window.WCRClassRoom.exitApp() 退出当前PC客户端 老师端、学生端
3 Window.WCRClassRoom.restartApp() 重启当前PC客户端 老师端、学生端
4 Window.WCRClassRoom. getLanguage () 获取当前的客户端语言选项 老师端、学生端
5 Window.WCRClassRoom. setLanguage (language) 设置当前客户端的语言选项，此调用完成后，建议调用restartApp使得语言选项生效，Language为字符串，为”en”或者”ch” 老师端、学生端
6 Window.WCRClassRoom.checkClientUpdate() 调起手动检测升级流程，整体逻辑和UI已经内部封装好，机构无需关心 老师端、学生端
7 Window.WCRClassRoom. openUrlByExternal () 外链打开，用系统默认的程序打开链接 老师端、学生端
8 window.webAdapter.reload() 刷新课表页 老师端、学生端

results matching ""

    No results matching ""