Function: activityContent()

Call Signature

function activityContent(
   context, 
   siteUrl, 
   activity, 
   options?
): Promise<ActivityContent>;

Defined in: areas/activities/content.ts:65

Reads a page's or label's text, a book's chapters, a URL resource's target, or a file resource's or folder's files. With the realistic trail, page by page at a reader's pace, calling onProgress with the seconds read so far while it pauses. Takes an activity as the course structure gives it ({ id, type }), or its id and module.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
activity	{ id: number; type: string; }
activity.id	number
activity.type?	string
options?	ContentOptions

Returns

Promise<ActivityContent>

Call Signature

function activityContent(
   context, 
   siteUrl, 
   activityId, 
   type, 
   options?
): Promise<ActivityContent>;

Defined in: areas/activities/content.ts:66

Reads a page's or label's text, a book's chapters, a URL resource's target, or a file resource's or folder's files. With the realistic trail, page by page at a reader's pace, calling onProgress with the seconds read so far while it pauses. Takes an activity as the course structure gives it ({ id, type }), or its id and module.

Parameters

Parameter	Type
context	BrowserContext
siteUrl	string
activityId	number
type	"page" | "book" | "label" | "url" | "resource" | "folder"
options?	ContentOptions

Returns

Promise<ActivityContent>