Options
All
  • Public
  • Public/Protected
  • All
Menu

Module service/learning

Index

Type aliases

Functions

Type aliases

CourseExpireInfo

CourseExpireInfo: { days: string; finishedAt: string; hours: string; minutes: string; seconds: string }

Type declaration

  • days: string

    正数-即将到期; 负数-逾期

  • finishedAt: string

    到期时间

  • hours: string

    正数-即将到期; 负数-逾期

  • minutes: string

    正数-即将到期; 负数-逾期

  • seconds: string

    正数-即将到期; 负数-逾期

CourseTestStatus

CourseTestStatus: "Success" | "Fail" | "Default" | "Approving"

课程测试状态

description

通过/未通过/待测试/审核中

LearnerCourse

LearnerCourse: LearningCourseBase & Partial<CourseExpireInfo> & { status: LearningStatus }

课程学习情况

LearnerRankItem

LearnerRankItem: { appid: string; headimgurl: string; learnerId: string; learningDuration: string; nickname: string; openid: string; rank: string }

课程排名信息

Type declaration

  • appid: string
  • headimgurl: string
  • learnerId: string
  • learningDuration: string

    歇息时长（秒）

  • nickname: string
  • openid: string
  • rank: string

    排名

LearningCourseBase

LearningCourseBase: { cover: string; description: string; id: string; isRegistered: boolean; isRequired: boolean; lecturers: string; name: string; progress: string; startAt: string }

Type declaration

  • cover: string

    封面

  • description: string

    描述

  • id: string

    课程id

  • isRegistered: boolean

    是否已参加该课程, true-已参加, false-未参加

  • isRequired: boolean

    是否为必修课程, true-必修课, false-非必修课

  • lecturers: string

    讲师

  • name: string

    课程名称

  • progress: string

    学习进度

  • startAt: string

    上线时间

LearningCourseDetail

LearningCourseDetail: LearningCourseBase & { documentUrls: string[]; finishedAt: string; form: { correctAnswers: string; id: string; status: CourseTestStatus }; imgUrls: string[]; lessons: LearningLesson[]; tags: { tagId: string; tagName: string }[]; videoUrls: string[] }

用户课程详情

LearningGroup

LearningGroup: { childsCount: string; groups?: LearningGroup; id: string; index: string; name: string }[]

LearningLesson

LearningLesson: { contentType: string; cover: string; duration: string; id: string; lecturer: string; name: string; size: string; status: LearningStatus; url: string; videoAnchor: string; videoAnchorMax: string; watermark?: WmImgOptions & { enabled: boolean } }

课程详情

Type declaration

  • contentType: string

    视频格式

  • cover: string

    课程视频封面

  • duration: string

    课程视频时长

  • id: string

    课程视频id

  • lecturer: string

    讲师

  • name: string

    课程视频名称

  • size: string

    视频文件大小

  • status: LearningStatus

    学习状态

  • url: string

    视频url

  • videoAnchor: string

    观看时长

  • videoAnchorMax: string

    最长观看时长

  • Optional watermark?: WmImgOptions & { enabled: boolean }

LearningStatus

LearningStatus: "ToLearn" | "Learning" | "Learned"

课程学习状态

description

ToLearn-待学习 Learning-学习中 Learned-已学习

Functions

GetAllRank

GetCourseDetail

  • 获取指定的课程详细信息

    Parameters

    • courseId: string

    Returns Promise<LearningCourseDetail>

GetCourses

  • 获取课程列表

    remarks

    根据下列字段查询： k 模糊查询；groupId 分组id

    export

    Parameters

    Returns ListResponse<LearningCourseBase[]>

GetCoursesByTags

GetExpiredCourses

GetLatestCourses

GetLearnerData

  • GetLearnerData(): Promise<{ courseLearnedCount: string; courseLearningCount: string; courseToLearnCount: string; courseTotalCount: string; durationsByDay: number; durationsByMonth: number; durationsByWeek: number; learnerId: string; requiredLearnedCount: string; requiredLearningCount: string; requiredToLearnCount: string; requiredTotalCount: string; totalDuration: number }>

  • 用户学习数据

    Returns Promise<{ courseLearnedCount: string; courseLearningCount: string; courseToLearnCount: string; courseTotalCount: string; durationsByDay: number; durationsByMonth: number; durationsByWeek: number; learnerId: string; requiredLearnedCount: string; requiredLearningCount: string; requiredToLearnCount: string; requiredTotalCount: string; totalDuration: number }>

GetLearnerInfo

  • GetLearnerInfo(): Promise<{ appid: string; courseIds: string[]; id: string; name: string; openid: string }>

  • 获取用户信息

    Returns Promise<{ appid: string; courseIds: string[]; id: string; name: string; openid: string }>

GetLearnerRank

  • 自己的排名信息

    Returns Promise<LearnerRankItem>

GetLearningGroups

  • 获取全部分组

    Returns Promise<LearningGroup>

GetLessonDetail

  • 获取课程视频详情

    Parameters

    • lessonId: string

    Returns Promise<LearningLesson>

GetMyCourses

  • 获取用户已参与的课程列表

    remarks

    根据下列字段查询： onlyRequired: 仅查询必修课程；status: 根据学习状态查询对应的课程

    export

    Parameters

    Returns ListResponse<LearnerCourse[]>

GetMyLatestCourses

ManageCourse

  • ManageCourse(courseId: string): Promise<void>

  • 参与/取消课程

    Parameters

    • courseId: string

    Returns Promise<void>

PostCourseActionRecording

  • PostCourseActionRecording(params?: { endAt: string; id: string }): Promise<string>

  • 记录用户访问行为（用于学习时间统计）

    Parameters

    • Optional params: { endAt: string; id: string }
      • endAt: string
      • id: string

    Returns Promise<string>

PushLearningRecord

  • PushLearningRecord(recording: { lesson?: { lessonId: string; videoAnchor: number; videoAnchorMax: number }; record?: { learning: undefined | number; test: undefined | number } }): Promise<{ timestamp: string }>

  • 时长统计：记录学习时长或课程进度

    export

    Parameters

    • recording: { lesson?: { lessonId: string; videoAnchor: number; videoAnchorMax: number }; record?: { learning: undefined | number; test: undefined | number } }
      • Optional lesson?: { lessonId: string; videoAnchor: number; videoAnchorMax: number }
        • lessonId: string
        • videoAnchor: number
        • videoAnchorMax: number
      • Optional record?: { learning: undefined | number; test: undefined | number }
        • learning: undefined | number
        • test: undefined | number

    Returns Promise<{ timestamp: string }>

    {Promise<{ timestamp: string }>}

RecordLearning

  • RecordLearning(body: { courseId: string; lessonId: string }): Promise<void>

  • 记录学习行为-开始学习和结束学习时调用

    deprecated

    使用RecordLessons的时间判断

    Parameters

    • body: { courseId: string; lessonId: string }
      • courseId: string
      • lessonId: string

    Returns Promise<void>

RecordLesson

  • RecordLesson(lessonId: string, videoAnchor: number, videoAnchorMax: number): Promise<void>

  • 记录课程视频学习情况

    Parameters

    • lessonId: string
    • videoAnchor: number

      课程视频学习时长

    • videoAnchorMax: number

    Returns Promise<void>

learningApi

  • learningApi(target: string, data?: any): Promise<any>

  • Parameters

    • target: string
    • Optional data: any

    Returns Promise<any>

Generated using TypeDoc