oc_event: Query Opencast for a specific event

In ebbertd/opencastR: 'Opencast' External API Package

Query Opencast for a specific event

Description

Returns a single event.

Usage

oc_event(
  eventId = "",
  sign = FALSE,
  withacl = FALSE,
  withmetadata = FALSE,
  withscheduling = FALSE,
  withpublications = FALSE
)

Arguments

eventId	The event id
sign	Whether public distribution urls should be signed.
withacl	Whether the acl metadata should be included in the response.
withmetadata	Whether the metadata catalogs should be included in the response.
withscheduling	Whether the scheduling information should be included in the response.
withpublications	Whether the publication ids and urls should be included in the response.

Details

This function expects the hostname, username and password to be set as environment variables.

Value

Returns a single event.

Examples

Sys.setenv(OPENCAST_HOST = "https://legacy.opencast.org")
Sys.setenv(OPENCAST_USERNAME = "admin")
Sys.setenv(OPENCAST_PASSWORD = "opencast")

events <- oc_list_events()

oc_event(events$content$identifier[1])

ebbertd/opencastR documentation built on March 23, 2022, 10:11 p.m.