PlatformApi class

Constructors

PlatformApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
platformOrgsCoursesCountRetrieve(String org, {String? format, int? groupId}) → Future<Count?>
Total courses on the platform
platformOrgsCoursesCountRetrieveWithHttpInfo(String org, {String? format, int? groupId}) → Future<Response>
Total courses on the platform
platformOrgsCoursesGradesRetrieve(String org) → Future<void>
Grading information on a per course basis
platformOrgsCoursesGradesRetrieveWithHttpInfo(String org) → Future<Response>
Grading information on a per course basis
platformOrgsCoursesProgressAverageDaysToCompleteRetrieve(String courseId, String org) → Future<void>
Average days used to complete a course Query Params 1. course_id
platformOrgsCoursesProgressAverageDaysToCompleteRetrieveWithHttpInfo(String courseId, String org) → Future<Response>
Average days used to complete a course Query Params 1. course_id
platformOrgsCoursesProgressAverageTimeToCompleteRetrieve(String courseId, String org) → Future<void>
Average time used to complete a course in secs Query Params 1. course_id
platformOrgsCoursesProgressAverageTimeToCompleteRetrieveWithHttpInfo(String courseId, String org) → Future<Response>
Average time used to complete a course in secs Query Params 1. course_id
platformOrgsCoursesProgressCompletedRetrieve(String courseId, String org) → Future<void>
For platform : Total users who have completed atleast a course on the platform For course : Total completions in course For learner : Total completed courses Query Params 1. course_id
platformOrgsCoursesProgressCompletedRetrieveWithHttpInfo(String courseId, String org) → Future<Response>
For platform : Total users who have completed atleast a course on the platform For course : Total completions in course For learner : Total completed courses Query Params 1. course_id
platformOrgsCoursesProgressCompletionRateRetrieve(String courseId, String org) → Future<void>
Average of total completed units
platformOrgsCoursesProgressCompletionRateRetrieveWithHttpInfo(String courseId, String org) → Future<Response>
Average of total completed units
platformOrgsCoursesProgressInProgressRetrieve(String courseId, String org) → Future<void>
In Progress means any unit completion in the past 30 days For platform : Total users who have atleast a course in_progress on the platform For course : Total users For learner : Total courses in progress Query Params 1. course_id
platformOrgsCoursesProgressInProgressRetrieveWithHttpInfo(String courseId, String org) → Future<Response>
In Progress means any unit completion in the past 30 days For platform : Total users who have atleast a course in_progress on the platform For course : Total users For learner : Total courses in progress Query Params 1. course_id
platformOrgsCoursesProgressRetrieve(String courseId, String org) → Future<void>
Completion information per enrolled user Gives Percentage of units completed in course Query Params course_id
platformOrgsCoursesProgressRetrieveWithHttpInfo(String courseId, String org) → Future<Response>
Completion information per enrolled user Gives Percentage of units completed in course Query Params course_id
platformOrgsCoursesProgressStartedRetrieve(String courseId, String org) → Future<void>
Started means an enrollment For platform : Total users who have atleast an enrollment For course : Total users enrolled For learner : Total courses in progress Query Params 1. course_id
platformOrgsCoursesProgressStartedRetrieveWithHttpInfo(String courseId, String org) → Future<Response>
Started means an enrollment For platform : Total users who have atleast an enrollment For course : Total users enrolled For learner : Total courses in progress Query Params 1. course_id
platformOrgsCoursesUsersGradesPassedRetrieve(String courseId, String org, String userId) → Future<void>
A GET View that validates QueryParams and returns results to a serializer
platformOrgsCoursesUsersGradesPassedRetrieveWithHttpInfo(String courseId, String org, String userId) → Future<Response>
A GET View that validates QueryParams and returns results to a serializer
platformOrgsCoursesUsersProgressDaysToCompleteRetrieve(String courseId, String org, String userId) → Future<void>
Average days used to complete a course Query Params 1. course_id
platformOrgsCoursesUsersProgressDaysToCompleteRetrieveWithHttpInfo(String courseId, String org, String userId) → Future<Response>
Average days used to complete a course Query Params 1. course_id
platformOrgsCoursesUsersProgressRetrieve(String courseId, String org, String userId, {String? format, int? groupId}) → Future<PerlearnerCourseProgress?>
Gives Percentage of units completed in course for a specific learner
platformOrgsCoursesUsersProgressRetrieveWithHttpInfo(String courseId, String org, String userId, {String? format, int? groupId}) → Future<Response>
Gives Percentage of units completed in course for a specific learner
platformOrgsCoursesUsersTimeCountRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Count?>
Time spent count in seconds within a course by a learner
platformOrgsCoursesUsersTimeCountRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Time spent count in seconds within a course by a learner
platformOrgsCoursesUsersVideosCountRetrieve(String courseId, String org, String userId, {String? format, int? groupId}) → Future<VideosCount?>
Total videos watched / Total Course Videos
platformOrgsCoursesUsersVideosCountRetrieveWithHttpInfo(String courseId, String org, String userId, {String? format, int? groupId}) → Future<Response>
Total videos watched / Total Course Videos
platformOrgsCoursesVideosRetrieve(String org, {String? format, int? groupId}) → Future<WatchedVideosPerCourse?>
Aggregated count of video plays on a per-course basis
platformOrgsCoursesVideosRetrieve2(String courseId, String org) → Future<void>
Count of total videos in a course Query Params course_id e.g course-v1:Org+Course4+Run
platformOrgsCoursesVideosRetrieve2WithHttpInfo(String courseId, String org) → Future<Response>
Count of total videos in a course Query Params course_id e.g course-v1:Org+Course4+Run
platformOrgsCoursesVideosRetrieveWithHttpInfo(String org, {String? format, int? groupId}) → Future<Response>
Aggregated count of video plays on a per-course basis
platformOrgsProgressCompletedRetrieve(String org) → Future<void>
For platform : Total users who have completed atleast a course on the platform For course : Total completions in course For learner : Total completed courses Query Params 1. course_id
platformOrgsProgressCompletedRetrieveWithHttpInfo(String org) → Future<Response>
For platform : Total users who have completed atleast a course on the platform For course : Total completions in course For learner : Total completed courses Query Params 1. course_id
platformOrgsProgressCompletionRateRetrieve(String org) → Future<void>
Average of total completed units
platformOrgsProgressCompletionRateRetrieveWithHttpInfo(String org) → Future<Response>
Average of total completed units
platformOrgsProgressInProgressRetrieve(String org) → Future<void>
In Progress means any unit completion in the past 30 days For platform : Total users who have atleast a course in_progress on the platform For course : Total users For learner : Total courses in progress Query Params 1. course_id
platformOrgsProgressInProgressRetrieveWithHttpInfo(String org) → Future<Response>
In Progress means any unit completion in the past 30 days For platform : Total users who have atleast a course in_progress on the platform For course : Total users For learner : Total courses in progress Query Params 1. course_id
platformOrgsProgressStartedRetrieve(String org) → Future<void>
Started means an enrollment For platform : Total users who have atleast an enrollment For course : Total users enrolled For learner : Total courses in progress Query Params 1. course_id
platformOrgsProgressStartedRetrieveWithHttpInfo(String org) → Future<Response>
Started means an enrollment For platform : Total users who have atleast an enrollment For course : Total users enrolled For learner : Total courses in progress Query Params 1. course_id
platformOrgsRetrieve(String org) → Future<void>
Learners list with email name and date_joined
platformOrgsRetrieveWithHttpInfo(String org) → Future<Response>
Learners list with email name and date_joined
platformOrgsTimeCountRetrieve(String org) → Future<void>
Total time spent count on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result is all time
platformOrgsTimeCountRetrieveWithHttpInfo(String org) → Future<Response>
Total time spent count on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default result is all time
platformOrgsUsersActiveCountRetrieve(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Overtime?>
Count of users with activity on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default is all time
platformOrgsUsersActiveCountRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Count of users with activity on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default is all time
platformOrgsUsersCountRetrieve(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Overtime?>
Count of users enrolled on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default is all time
platformOrgsUsersCountRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Count of users enrolled on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default is all time
platformOrgsUsersCoursesCompletedCountRetrieve(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Overtime?>
Count of users who have completed a course on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default is all time
platformOrgsUsersCoursesCompletedCountRetrieveWithHttpInfo(String org, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Count of users who have completed a course on the platform within specified range or all time Query Params 1. start_date e.g 2020-10-01 2. end_date e.g 2020-10-10 Default is all time
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited