CoursesListOptions

import type { CoursesListOptions } from "https://googleapis.deno.dev/v1/classroom:v1.ts";

Additional options for Classroom#coursesList.

interface CoursesListOptions {

courseStates?:

| "COURSE_STATE_UNSPECIFIED"

| "ACTIVE"

| "ARCHIVED"

| "PROVISIONED"

| "DECLINED"

| "SUSPENDED";

pageSize?: number;

pageToken?: string;

studentId?: string;

teacherId?: string;

}

§Properties

[src]

Restricts returned courses to those in one of the specified states. If unspecified, Courses in any state are returned.

pageSize?: number

[src]

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

pageToken?: string

[src]

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

studentId?: string

[src]

Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user If specified, teacher_id must be empty.

teacherId?: string

[src]

Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal "me", indicating the requesting user If specified, student_id must be empty.