Get Assignments — wk_assignments • rwanikani

Retrieves assignment information showing the user's progress on subjects.

Usage

wk_assignments(
  ids = NULL,
  subject_ids = NULL,
  subject_types = NULL,
  levels = NULL,
  srs_stages = NULL,
  unlocked_at_after = NULL,
  unlocked_at_before = NULL,
  available_at_after = NULL,
  available_at_before = NULL,
  burned = NULL,
  updated_after = NULL,
  all_pages = FALSE
)

Arguments

ids: Vector of assignment IDs to retrieve.
subject_ids: Vector of subject IDs to filter assignments by.
subject_types: Vector of subject types to filter by.
levels: Vector of levels to filter by.
srs_stages: Vector of SRS stages to filter by (1-9).
unlocked_at_after: POSIXct datetime to filter assignments unlocked after this time.
unlocked_at_before: POSIXct datetime to filter assignments unlocked before this time.
available_at_after: POSIXct datetime to filter assignments available after this time.
available_at_before: POSIXct datetime to filter assignments available before this time.
burned: Logical to filter burned assignments.
updated_after: POSIXct datetime to filter assignments updated after this time.
all_pages: Logical indicating whether to fetch all pages (default: FALSE).

Value

A list containing assignments data and pagination information.

Examples

if (FALSE) { # \dontrun{
# Get all assignments
assignments <- wk_assignments(all_pages = TRUE)

# Get assignments for specific levels
level_assignments <- wk_assignments(levels = 1:5)

# Get burned assignments
burned <- wk_assignments(burned = TRUE)
} # }