get_wpages_list: Get data frame of pages in course

View source: R/pages.R

get_wpages_listR Documentation

Get data frame of pages in course

Description

Get data frame of pages in course

Usage

get_wpages_list(
  course_id,
  sort_type = c("title", "created_at", "updated_at")[1],
  order_type = "asc",
  search = NULL,
  published = NULL
)

Arguments

course_id

a valid course id

sort_type

a string, Sort results by this field. Allowed values: 'title', 'created_at', and 'updated_at'

order_type

a string. The sorting order. Defaults to 'asc'. Allowed values: asc, desc

search

a string. The partial title of the pages to match and return.

published

a boolean. If true, include only published paqes. If false, exclude published pages. If not present, do not filter on published status. Defaults to not present.

Value

a data.frame with all pages from course.


daranzolin/rcanvas documentation built on May 18, 2024, 2:33 p.m.