Class: Google::Apis::ClassroomV1::Invitation
- Inherits:
-
Object
- Object
- Google::Apis::ClassroomV1::Invitation
- Defined in:
- generated/google/apis/classroom_v1/classes.rb,
generated/google/apis/classroom_v1/representations.rb,
generated/google/apis/classroom_v1/representations.rb
Overview
An invitation to join a course.
Instance Attribute Summary collapse
-
#course_id ⇒ String
Identifier of the course to invite the user to.
-
#id ⇒ String
Identifier assigned by Classroom.
-
#role ⇒ String
Role to invite the user to have.
-
#user_id ⇒ String
Identifier of the invited user.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Invitation
constructor
A new instance of Invitation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Invitation
Returns a new instance of Invitation
1090 1091 1092 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 1090 def initialize(**args) update!(**args) end |
Instance Attribute Details
#course_id ⇒ String
Identifier of the course to invite the user to.
Corresponds to the JSON property courseId
1066 1067 1068 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 1066 def course_id @course_id end |
#id ⇒ String
Identifier assigned by Classroom.
Read-only.
Corresponds to the JSON property id
1072 1073 1074 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 1072 def id @id end |
#role ⇒ String
Role to invite the user to have.
Must not be COURSE_ROLE_UNSPECIFIED
.
Corresponds to the JSON property role
1078 1079 1080 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 1078 def role @role end |
#user_id ⇒ String
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 Corresponds to the JSON propertyuserId
1088 1089 1090 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 1088 def user_id @user_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1095 1096 1097 1098 1099 1100 |
# File 'generated/google/apis/classroom_v1/classes.rb', line 1095 def update!(**args) @course_id = args[:course_id] if args.key?(:course_id) @id = args[:id] if args.key?(:id) @role = args[:role] if args.key?(:role) @user_id = args[:user_id] if args.key?(:user_id) end |