Class: Google::Apis::ClassroomV1::Invitation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Invitation

Returns a new instance of Invitation.



1160
1161
1162
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1160

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

Returns:

  • (String) 


1140
1141
1142
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1140

def course_id
  @course_id
end

#id ⇒ String

Identifier assigned by Classroom. Read-only. Corresponds to the JSON property id

Returns:

  • (String) 


1145
1146
1147
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1145

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

Returns:

  • (String) 


1150
1151
1152
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1150

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 property userId

Returns:

  • (String) 


1158
1159
1160
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1158

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1165
1166
1167
1168
1169
1170
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1165

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