Class: Google::Apis::ClassroomV1::Guardian

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

Association between a student and a guardian of that student. The guardian may receive information about the student's course work.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Guardian

Returns a new instance of Guardian.



1014
1015
1016
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1014

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#guardian_id ⇒ String

Identifier for the guardian. Corresponds to the JSON property guardianId

Returns:

  • (String) 


996
997
998
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 996

def guardian_id
  @guardian_id
end

#guardian_profile ⇒ Google::Apis::ClassroomV1::UserProfile

Global information for a user. Corresponds to the JSON property guardianProfile

Returns:



1001
1002
1003
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1001

def guardian_profile
  @guardian_profile
end

#invited_email_address ⇒ String

The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators. Corresponds to the JSON property invitedEmailAddress

Returns:

  • (String) 


1007
1008
1009
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1007

def invited_email_address
  @invited_email_address
end

#student_id ⇒ String

Identifier for the student to whom the guardian relationship applies. Corresponds to the JSON property studentId

Returns:

  • (String) 


1012
1013
1014
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1012

def student_id
  @student_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1019
1020
1021
1022
1023
1024
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1019

def update!(**args)
  @guardian_id = args[:guardian_id] if args.key?(:guardian_id)
  @guardian_profile = args[:guardian_profile] if args.key?(:guardian_profile)
  @invited_email_address = args[:invited_email_address] if args.key?(:invited_email_address)
  @student_id = args[:student_id] if args.key?(:student_id)
end