Documentation

Namespace

Activity

CompassClient.Activity

Activity.svc Requests

View Source requests/Activity.js, line 1

Methods

# static getLessonsByActivityId(activityId) → {Promise.<LessonSummaryResponse>}

Requests all lessons and activity info by Activity Id

Parameters:
Name Type Description
activityId number

ActivityId of Activity and lessons

View Source requests/Activity.js, line 26

Resolves Activity info with array of Lesson objects

Promise.<LessonSummaryResponse>

# static getLessonsByActivityIdQuick(activityId) → {Promise.<LessonResponse>}

Requests upcoming lesson and activity info by Activity Id

Parameters:
Name Type Description
activityId number

ActivityId of upcoming lesson

View Source requests/Activity.js, line 14

Resolves Lesson object (includes activity info)

Promise.<LessonResponse>

# static getLessonsByInstanceId(instanceId) → {Promise.<LessonSummaryResponse>}

Requests all lessons and activity info by a child Lesson Id

Parameters:
Name Type Description
instanceId number

Instance Id of Activity and lessons

View Source requests/Activity.js, line 50

Resolves Activity info with array of Lesson objects

Promise.<LessonSummaryResponse>

# static getLessonsByInstanceIdQuick(instanceId) → {Promise.<LessonResponse>}

Requests upcoming lesson and activity info by a childLesson Id

Parameters:
Name Type Description
instanceId number

InstanceId of upcoming lesson

View Source requests/Activity.js, line 38

Resolves Lesson object (includes activity info)

Promise.<LessonResponse>