Class: Google::Apis::ClassroomV1::GuardianInvitation

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 become the guardian of a specified user, sent to a specified email address.

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) ⇒ GuardianInvitation

Returns a new instance of GuardianInvitation.


993
994
995
# File 'generated/google/apis/classroom_v1/classes.rb', line 993

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

Instance Attribute Details

#creation_timeString

The time that this invitation was created. Read-only. Corresponds to the JSON property creationTime

Returns:

  • (String)

970
971
972
# File 'generated/google/apis/classroom_v1/classes.rb', line 970

def creation_time
  @creation_time
end

#invitation_idString

Unique identifier for this invitation. Read-only. Corresponds to the JSON property invitationId

Returns:

  • (String)

975
976
977
# File 'generated/google/apis/classroom_v1/classes.rb', line 975

def invitation_id
  @invitation_id
end

#invited_email_addressString

Email address that the invitation was sent to. This field is only visible to domain administrators. Corresponds to the JSON property invitedEmailAddress

Returns:

  • (String)

981
982
983
# File 'generated/google/apis/classroom_v1/classes.rb', line 981

def invited_email_address
  @invited_email_address
end

#stateString

The state that this invitation is in. Corresponds to the JSON property state

Returns:

  • (String)

986
987
988
# File 'generated/google/apis/classroom_v1/classes.rb', line 986

def state
  @state
end

#student_idString

ID of the student (in standard format) Corresponds to the JSON property studentId

Returns:

  • (String)

991
992
993
# File 'generated/google/apis/classroom_v1/classes.rb', line 991

def student_id
  @student_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


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

def update!(**args)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @invitation_id = args[:invitation_id] if args.key?(:invitation_id)
  @invited_email_address = args[:invited_email_address] if args.key?(:invited_email_address)
  @state = args[:state] if args.key?(:state)
  @student_id = args[:student_id] if args.key?(:student_id)
end