google_api_classroom v0.14.3 GoogleApi.Classroom.V1.Model.Invitation View Source

An invitation to join a course.

Attributes

  • courseId (type: String.t, default: nil) - Identifier of the course to invite the user to.

  • id (type: String.t, default: nil) - Identifier assigned by Classroom.

    Read-only.

  • role (type: String.t, default: nil) - Role to invite the user to have. Must not be COURSE_ROLE_UNSPECIFIED.

  • userId (type: String.t, default: nil) - Identifier of the invited user.

    When specified as a parameter of a request, this identifier can be set to one of the following:

    • the numeric identifier for the user
    • the email address of the user
    • the string literal "me", indicating the requesting user

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Classroom.V1.Model.Invitation{
  courseId: String.t(),
  id: String.t(),
  role: String.t(),
  userId: String.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.