Class: Google::Apis::ClassroomV1::CourseWorkMaterial

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

Course work material created by a teacher for students of the course

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CourseWorkMaterial

Returns a new instance of CourseWorkMaterial.



748
749
750
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 748

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

Instance Attribute Details

Absolute link to this course work material in the Classroom web UI. This is only populated if state is PUBLISHED. Read-only. Corresponds to the JSON property alternateLink

Returns:

  • (String) 


673
674
675
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 673

def alternate_link
  @alternate_link
end

#assignee_mode ⇒ String

Assignee mode of the course work material. If unspecified, the default value is ALL_STUDENTS. Corresponds to the JSON property assigneeMode

Returns:

  • (String) 


679
680
681
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 679

def assignee_mode
  @assignee_mode
end

#course_id ⇒ String

Identifier of the course. Read-only. Corresponds to the JSON property courseId

Returns:

  • (String) 


684
685
686
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 684

def course_id
  @course_id
end

#creation_time ⇒ String

Timestamp when this course work material was created. Read-only. Corresponds to the JSON property creationTime

Returns:

  • (String) 


689
690
691
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 689

def creation_time
  @creation_time
end

#creator_user_id ⇒ String

Identifier for the user that created the course work material. Read-only. Corresponds to the JSON property creatorUserId

Returns:

  • (String) 


694
695
696
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 694

def creator_user_id
  @creator_user_id
end

#description ⇒ String

Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters. Corresponds to the JSON property description

Returns:

  • (String) 


700
701
702
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 700

def description
  @description
end

#id ⇒ String

Classroom-assigned identifier of this course work material, unique per course. Read-only. Corresponds to the JSON property id

Returns:

  • (String) 


706
707
708
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 706

def id
  @id
end

#individual_students_options ⇒ Google::Apis::ClassroomV1::IndividualStudentsOptions

Assignee details about a coursework/announcement. This field is set if and only if assigneeMode is INDIVIDUAL_STUDENTS. Corresponds to the JSON property individualStudentsOptions

Returns:



712
713
714
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 712

def individual_students_options
  @individual_students_options
end

#materials ⇒ Array<Google::Apis::ClassroomV1::Material>

Additional materials. A course work material must have no more than 20 material items. Corresponds to the JSON property materials

Returns:



718
719
720
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 718

def materials
  @materials
end

#scheduled_time ⇒ String

Optional timestamp when this course work material is scheduled to be published. Corresponds to the JSON property scheduledTime

Returns:

  • (String) 


723
724
725
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 723

def scheduled_time
  @scheduled_time
end

#state ⇒ String

Status of this course work material. If unspecified, the default state is DRAFT. Corresponds to the JSON property state

Returns:

  • (String) 


729
730
731
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 729

def state
  @state
end

#title ⇒ String

Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters. Corresponds to the JSON property title

Returns:

  • (String) 


735
736
737
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 735

def title
  @title
end

#topic_id ⇒ String

Identifier for the topic that this course work material is associated with. Must match an existing topic in the course. Corresponds to the JSON property topicId

Returns:

  • (String) 


741
742
743
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 741

def topic_id
  @topic_id
end

#update_time ⇒ String

Timestamp of the most recent change to this course work material. Read-only. Corresponds to the JSON property updateTime

Returns:

  • (String) 


746
747
748
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 746

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 753

def update!(**args)
  @alternate_link = args[:alternate_link] if args.key?(:alternate_link)
  @assignee_mode = args[:assignee_mode] if args.key?(:assignee_mode)
  @course_id = args[:course_id] if args.key?(:course_id)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @individual_students_options = args[:individual_students_options] if args.key?(:individual_students_options)
  @materials = args[:materials] if args.key?(:materials)
  @scheduled_time = args[:scheduled_time] if args.key?(:scheduled_time)
  @state = args[:state] if args.key?(:state)
  @title = args[:title] if args.key?(:title)
  @topic_id = args[:topic_id] if args.key?(:topic_id)
  @update_time = args[:update_time] if args.key?(:update_time)
end