OBJECT

CourseItem

A Course Item

link GraphQL Schema definition

  • type CourseItem {
  • # whether the attached object is a video form
  • attached_object_is_video: Boolean
  • # Shows if the current course item is blocked by an incomplete previous required
  • # item
  • #
  • # Arguments
  • # course_membership_id: Get the completed course item for the
  • # given membership and course_item
  • blocked_by_prev_item(course_membership_id: ID): Boolean
  • # category of item
  • category: String
  • # Check if course item was completed by a client
  • #
  • # Arguments
  • # client_id: The ID of the client
  • completed_by_client(client_id: ID): Boolean
  • # The completed course item
  • #
  • # Arguments
  • # course_membership_id: Get the completed course item for the
  • # given membership and course_item
  • completed_course_item(course_membership_id: ID): CompletedCourseItem
  • # The number of members who completed the item
  • completed_memberships_count: Int
  • # Determines whether or not completion of the course item is necessary to access
  • # the next
  • completion_required_for_next_module: Boolean!
  • # The associated course
  • course: Course
  • # id of course associated with item
  • course_id: ID
  • # name of course that item belongs to
  • course_name: String
  • # when item was created
  • created_at: String!
  • # type of custom module of a course item (if app)
  • custom_module_type: String
  • # Shows if the current course item is blocked due to course membership date
  • # restriction
  • #
  • # Arguments
  • # course_membership_id: The ID of a course membership
  • date_restricted(course_membership_id: ID): Boolean
  • # description of item
  • description: String
  • # The path to edit the item
  • edit_url: String
  • # This is the first required module that is incomplete, and will block items in
  • # higher positions
  • first_incomplete_required_module: CourseItem
  • # Course item has matrix field
  • has_matrix_field: Boolean
  • # The unique identifier of the item
  • id: ID!
  • # The ID of an incomplete form associated with the item
  • #
  • # Arguments
  • # course_membership_id: The ID of a course membership
  • incomplete_course_item_id(course_membership_id: ID): ID
  • # id of item
  • item_id: ID
  • # type of course item
  • item_type: String
  • # name of item
  • name: String
  • # The next item in the course
  • next_item: CourseItem
  • # Check if course item is available to a client
  • #
  • # Arguments
  • # client_id: The ID of a client
  • not_available_for_client(client_id: ID): Boolean
  • # Check if course item is available to any client
  • not_available_to_any_clients: Boolean
  • # The position of the course item type when shown in a list of other modules on
  • # the same day
  • position: Int
  • # The previous item in the course
  • prev_item: CourseItem
  • # scheduled release?
  • scheduled_release: String
  • # when item was updated
  • updated_at: String!
  • # id of user associated with item
  • user_id: ID
  • # The path to view the item
  • view_url: String
  • }