REST Resource: invitations

资源：邀请

加入课程的邀请。

JSON 表示法 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
字段
id

string

Google 课堂分配的标识符。

只读。
userId

string

受邀用户的标识符。

当指定为请求的参数时，可将此标识符设置为以下其中一项：

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me"，表示发出请求的用户
courseId

string

要邀请用户访问的课程的标识符。
role

enum (CourseRole)

邀请用户拥有的角色。不得为 COURSE_ROLE_UNSPECIFIED。

课程角色

用户可能受邀拥有的角色。

枚举
COURSE_ROLE_UNSPECIFIED 无课程角色。
STUDENT 学习此课程的学生。
TEACHER 课程的教师。
OWNER 课程的所有者。

方法

accept

 接受邀请，移除邀请，并将受邀用户添加到指定课程的教师或学生（如果适用）。

create

 创建邀请。

delete

 删除邀请。

get

 返回邀请。

list

 返回请求用户有权查看的邀请列表，仅限与该列表请求匹配的邀请。