Interface EscolaLMSContextAPIConfig

Hierarchy

  • EscolaLMSContextAPIConfig

Properties

addConsultationAccess addCourseAccess addMissingProducts addTask addToCart apiUrl approveConsultationTerm attachProduct bookConsultationTerm cancelSubscription changeConsultationTerm changePassword confirmAccountDelete courseProgress createBookmarkNote createTaskNote createTeamsChat deleteAccount deleteBookmarkNote deleteConsultationAccess deleteCourseAccess deleteTask deleteTaskNote emailVerify fetchAcademicYears fetchAttendances fetchBookmarkNotes fetchCart fetchCategories fetchCertificate fetchCertificates fetchChallenge fetchChallenges fetchConfig fetchConsultation fetchConsultationAccess fetchConsultationAccessEnquiry fetchConsultations fetchCourse fetchCourseAccess fetchCourseProgress fetchCourses fetchDictionariesAccess fetchDictionariesWord fetchDictionariesWords fetchDictionariesWordsCategories fetchEvents fetchExams fetchFields fetchH5P fetchMattermostChannels fetchMyAuthoredCourses fetchMyCourses fetchMyProducts fetchNotifications fetchOrderInvoice fetchOrders fetchPage fetchPages fetchPaginatedProgress fetchPayments fetchProduct fetchProducts fetchProfile fetchProgram fetchProgress fetchQuestionnaire fetchQuestionnaireStars fetchQuestionnaireStarsByModel fetchQuestionnaires fetchQuestionnairesAnswers fetchRegisterableGroups fetchSchedule fetchScheduleTutors fetchSemesters fetchSettings fetchStationaryEvent fetchStationaryEvents fetchSubjects fetchTags fetchTask fetchTasks fetchTutor fetchTutorConsultations fetchTutors fetchUserConsultations fetchUserGroup fetchUserGroups fetchUserStationaryEvents fetchUserWebinars fetchWebinar fetchWebinars forgot generateCertificate generateConsultationJitsy generateWebinarJitsy getImagePrefix getImageSvgPrefix getNextPrevTopic getProductInfo getRefreshedToken h5pProgress initAccountDelete login logout payWithP24 payWithStripe readAllNotifications readNotify realizeVoucher register rejectConsultationTerm removeFromCart removeVoucher reset resetCart sendProgress sendQuestionnaireAnswer socialAuthorize subscriptionPayWithP24 topicIsFinished topicPing updateAvatar updateBookmarkNote updateConsultationAccess updateProfile updateProfileEmail updateTask updateTaskNote updateTaskStatus

Properties

addMissingProducts: ((products: number[]) => Promise<void>)

Type declaration

    • (products: number[]): Promise<void>
    • Parameters

      • products: number[]

      Returns Promise<void>

addTask: ((data: CreateTaskRequest) => Promise<DefaultResponse<API.Task>>)

Type declaration

addToCart: ((id: number, quantity?: number) => Promise<AddProductResponse>)

Type declaration

apiUrl: string
approveConsultationTerm: ((consultation: number) => Promise<void | DefaultResponseError | PaginatedMetaList<AppointmentTerm> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<AppointmentTerm>>)

Type declaration

attachProduct: ((productableId: number, productableType: string) => Promise<DefaultResponse<null>>)

Type declaration

    • (productableId: number, productableType: string): Promise<DefaultResponse<null>>
    • Parameters

      • productableId: number
      • productableType: string

      Returns Promise<DefaultResponse<null>>

bookConsultationTerm: ((id: number, term: string) => Promise<ScheduleConsultationResponse>)

Type declaration

cancelSubscription: ((productId: number) => Promise<DefaultResponse<null>>)

Type declaration

changeConsultationTerm: ((termId: number, newDate: string) => Promise<DefaultResponse<object>>)

Type declaration

    • (termId: number, newDate: string): Promise<DefaultResponse<object>>
    • Parameters

      • termId: number
      • newDate: string

      Returns Promise<DefaultResponse<object>>

changePassword: ((body: ChangePasswordRequest) => Promise<AuthResponse>)

Type declaration

confirmAccountDelete: ((userId: string, deleteToken: string) => Promise<AuthResponse>)

Type declaration

    • (userId: string, deleteToken: string): Promise<AuthResponse>
    • Parameters

      • userId: string
      • deleteToken: string

      Returns Promise<AuthResponse>

courseProgress: ((courseId: number) => number)

Type declaration

    • (courseId: number): number
    • Parameters

      • courseId: number

      Returns number

createBookmarkNote: ((body: CreateBookmarkNote) => Promise<DefaultResponse<BookmarkNote>>)

Type declaration

createTaskNote: ((id: number, note: string) => Promise<DefaultResponse<API.TaskNote>>)

Type declaration

createTeamsChat: ((id: number) => Promise<TeamsChatResponse>)

Type declaration

deleteAccount: (() => Promise<AuthResponse>)

Type declaration

deleteBookmarkNote: ((id: number) => Promise<DefaultResponse<BookmarkNote>>)

Type declaration

deleteConsultationAccess: ((id: number) => Promise<DefaultResponse<ConsultationAccessEnquiry>>)

Type declaration

deleteCourseAccess: ((id: number) => Promise<DefaultResponse<API.CourseAccessEnquiry>>)

Type declaration

deleteTask: ((id: number) => Promise<DefaultResponse<API.Task>>)

Type declaration

deleteTaskNote: ((taskNoteId: number) => Promise<DefaultResponse<API.TaskNote>>)

Type declaration

emailVerify: ((id: string, hash: string) => Promise<AuthResponse>)

Type declaration

fetchAcademicYears: ((params?: AcademicYearParams) => Promise<void | DefaultResponseError | DefaultResponseSuccess<AcademicYear> | PaginatedMetaList<AcademicYear> & {
    message: string;
    success: true;
}>)

Type declaration

fetchAttendances: ((groupId: number) => Promise<DefaultResponse<Attendance[]>>)

Type declaration

fetchBookmarkNotes: ((filter?: BookmarkNoteParams) => Promise<DefaultMetaResponse<BookmarkNote>>)

Type declaration

fetchCart: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<API.Cart> | PaginatedMetaList<API.Cart> & {
    message: string;
    success: true;
}>)

Type declaration

fetchCategories: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<API.Category> | PaginatedMetaList<API.Category> & {
    message: string;
    success: true;
}>)

Type declaration

fetchCertificate: ((id: number) => Promise<DefaultResponse<Certificate>>)

Type declaration

fetchCertificates: ((params?: CertificateParams) => Promise<void | DefaultResponseError | PaginatedMetaList<Certificate> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<Certificate>>)

Type declaration

fetchChallenge: ((id: number) => Promise<DefaultResponse<CompetencyChallenge>>)

Type declaration

fetchChallenges: ((filter: ChallengesParams) => Promise<DefaultMetaResponse<CompetencyChallenge>>)

Type declaration

fetchConfig: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<AppConfig> | PaginatedMetaList<AppConfig> & {
    message: string;
    success: true;
}>)

Type declaration

fetchConsultation: ((id: number) => Promise<void | DefaultResponseError | PaginatedMetaList<API.Consultation> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Consultation>>)

Type declaration

fetchConsultationAccess: ((filter?: CourseAccessEnquiryListParams) => Promise<DefaultMetaResponse<ConsultationAccessEnquiry>>)
fetchConsultationAccessEnquiry: ((enquiryId: number) => Promise<DefaultResponse<ConsultationAccessEnquiry>>)

Type declaration

fetchConsultations: ((filter: ConsultationParams) => Promise<void | DefaultResponseError | PaginatedMetaList<API.Consultation> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Consultation>>)

Type declaration

fetchCourse: ((id: number) => Promise<DefaultResponse<API.Course>>)

Type declaration

fetchCourseAccess: ((filter?: CourseAccessEnquiryListParams) => Promise<DefaultMetaResponse<API.CourseAccessEnquiry>>)
fetchCourseProgress: ((courseId: number) => Promise<void>)

Type declaration

    • (courseId: number): Promise<void>
    • Parameters

      • courseId: number

      Returns Promise<void>

fetchCourses: ((filter: CourseParams) => Promise<DefaultMetaResponse<API.Course>>)

Type declaration

fetchDictionariesAccess: (() => Promise<DefaultResponse<DictionariesAccess>>)

Type declaration

fetchDictionariesWord: ((slug: string, id: number) => Promise<DefaultResponse<DictionariesWords>>)

Type declaration

fetchDictionariesWords: ((slug: string, params?: DictionariesWordsParams) => Promise<DefaultMetaResponse<DictionariesWords>>)

Type declaration

fetchDictionariesWordsCategories: ((slig: string, params?: DictionariesParams) => Promise<void | DefaultResponseError | DefaultResponseSuccess<DictionariesWordsCategory> | PaginatedMetaList<DictionariesWordsCategory> & {
    message: string;
    success: true;
}>)

Type declaration

fetchEvents: ((filter: EventsParams) => Promise<void | DefaultResponseError | PaginatedMetaList<Event> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<Event>>)

Type declaration

fetchExams: ((params?: ExamsParams) => Promise<void | DefaultResponseError | DefaultResponseSuccess<Exam[]> | PaginatedMetaList<Exam[]> & {
    message: string;
    success: true;
}>)

Type declaration

fetchFields: ((filter: FieldsParams) => Promise<void | DefaultResponseError | DefaultResponseSuccess<API.Metadata> | PaginatedMetaList<API.Metadata> & {
    message: string;
    success: true;
}>)

Type declaration

fetchH5P: ((uuid: string) => void)

Type declaration

    • (uuid: string): void
    • Parameters

      • uuid: string

      Returns void

fetchMattermostChannels: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<MattermostData> | PaginatedMetaList<MattermostData> & {
    message: string;
    success: true;
}>)

Type declaration

fetchMyAuthoredCourses: ((params?: PaginationParams) => Promise<void | DefaultResponseError | PaginatedMetaList<API.Course> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Course>>)

Type declaration

fetchMyCourses: (() => Promise<void>)

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

fetchMyProducts: ((filter: PageParams & PaginationParams & {
    name?: string;
    productable_type?: string;
    tags[]?: string;
    type?: string;
}) => Promise<DefaultMetaResponse<API.Product>>)

Type declaration

fetchNotifications: ((filter?: PaginationParams) => Promise<DefaultMetaResponse<Notification>>)

Type declaration

fetchOrderInvoice: ((id: number, options?: RequestOptionsInit) => Promise<<internal>.Blob>)

Type declaration

fetchOrders: ((params?: PaginationParams & {
    status?: number;
}) => Promise<void | DefaultResponseError | PaginatedMetaList<API.Order> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Order>>)

Type declaration

fetchPage: ((slug: string) => Promise<void | DefaultResponseError | PaginatedMetaList<API.Page> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Page>>)

Type declaration

fetchPages: (() => Promise<void | DefaultResponseError | PaginatedMetaList<API.Page> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Page>>)

Type declaration

fetchPaginatedProgress: ((filter: PaginatedProgressParams) => Promise<DefaultMetaResponse<CourseProgressItem>>)

Type declaration

fetchPayments: (() => Promise<void | DefaultResponseError | PaginatedMetaList<API.Payment> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Payment>>)

Type declaration

fetchProduct: ((id: number) => Promise<DefaultResponse<API.Product>>)

Type declaration

fetchProducts: ((filter: PageParams & PaginationParams & {
    name?: string;
    productable_type?: string;
    tags[]?: string;
    type?: string;
}) => Promise<DefaultMetaResponse<API.Product>>)

Type declaration

fetchProfile: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<UserAsProfile> | PaginatedMetaList<UserAsProfile> & {
    message: string;
    success: true;
}>)

Type declaration

fetchProgram: ((id: number) => Promise<DefaultResponse<CourseProgram>>)

Type declaration

fetchProgress: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<API.CourseProgress> | PaginatedMetaList<API.CourseProgress> & {
    message: string;
    success: true;
}>)

Type declaration

fetchQuestionnaire: ((modelTypeTitle: string, modelID: number, id: number) => Promise<DefaultResponse<QuestionnaireAnswerResponse>>)

Type declaration

fetchQuestionnaireStars: ((modelTypeTitle: string, modelID: number, id: number) => Promise<DefaultResponse<QuestionnaireStars>>)

Type declaration

fetchQuestionnaireStarsByModel: ((modelTypeTitle: string, modelID: number) => Promise<DefaultResponse<QuestionnaireStarsModel>>)

Type declaration

fetchQuestionnaires: ((model: string, id: number) => Promise<DefaultMetaResponse<API.Questionnaire>>)

Type declaration

fetchQuestionnairesAnswers: ((modelTypeTitle: string, modelID: number, id: number, params?: PaginationParams) => Promise<DefaultMetaResponse<API.QuestionAnswer>>)

Type declaration

fetchRegisterableGroups: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<UserGroup> | PaginatedMetaList<UserGroup> & {
    message: string;
    success: true;
}>)

Type declaration

fetchSchedule: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<ScheduleData> | PaginatedMetaList<ScheduleData> & {
    message: string;
    success: true;
}>)

Type declaration

fetchScheduleTutors: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<LessonTutor> | PaginatedMetaList<LessonTutor> & {
    message: string;
    success: true;
}>)

Type declaration

fetchSemesters: ((params?: SemestersParams) => Promise<void | DefaultResponseError | DefaultResponseSuccess<SemesterData> | PaginatedMetaList<SemesterData> & {
    message: string;
    success: true;
}>)

Type declaration

fetchSettings: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<any> | PaginatedMetaList<any> & {
    message: string;
    success: true;
}>)

Type declaration

fetchStationaryEvent: ((id: number) => Promise<void | DefaultResponseError | PaginatedMetaList<API.StationaryEvent> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.StationaryEvent>>)

Type declaration

fetchStationaryEvents: ((filter: StationaryEventsParams) => Promise<void | DefaultResponseError | PaginatedMetaList<API.StationaryEvent> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.StationaryEvent>>)

Type declaration

fetchSubjects: ((params?: SubjectsParams) => Promise<void | DefaultResponseError | PaginatedMetaList<GroupSubject> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<GroupSubject>>)

Type declaration

fetchTags: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<API.Tag> | PaginatedMetaList<API.Tag> & {
    message: string;
    success: true;
}>)

Type declaration

fetchTask: ((id: number) => Promise<void | DefaultResponseError | PaginatedMetaList<API.Task> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Task>>)

Type declaration

fetchTasks: ((filter: TaskParams) => Promise<DefaultMetaResponse<API.Task>>)

Type declaration

fetchTutor: ((id: number) => Promise<void | DefaultResponseError | DefaultResponseSuccess<UserItem> | PaginatedMetaList<UserItem> & {
    message: string;
    success: true;
}>)

Type declaration

fetchTutorConsultations: (() => Promise<void | DefaultResponseError | PaginatedMetaList<AppointmentTerm> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<AppointmentTerm>>)

Type declaration

fetchTutors: (() => Promise<void | DefaultResponseError | DefaultResponseSuccess<UserItem> | PaginatedMetaList<UserItem> & {
    message: string;
    success: true;
}>)

Type declaration

fetchUserConsultations: (() => Promise<void | DefaultResponseError | PaginatedMetaList<API.Consultation> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Consultation>>)

Type declaration

fetchUserGroup: ((id: number) => Promise<void | DefaultResponseError | DefaultResponseSuccess<UserGroup> | PaginatedMetaList<UserGroup> & {
    message: string;
    success: true;
}>)

Type declaration

fetchUserGroups: ((params: UserGroupsParams) => Promise<void | DefaultResponseError | DefaultResponseSuccess<UserGroup> | PaginatedMetaList<UserGroup> & {
    message: string;
    success: true;
}>)

Type declaration

fetchUserStationaryEvents: (() => Promise<void | DefaultResponseError | PaginatedMetaList<API.StationaryEvent> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.StationaryEvent>>)

Type declaration

fetchUserWebinars: (() => Promise<void | DefaultResponseError | PaginatedMetaList<API.Webinar> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<API.Webinar>>)

Type declaration

fetchWebinar: ((id: number) => Promise<DefaultResponse<API.Webinar>>)

Type declaration

fetchWebinars: ((filter: WebinarParams) => Promise<DefaultMetaResponse<API.Webinar>>)

Type declaration

forgot: ((body: ForgotRequest) => Promise<AuthResponse>)

Type declaration

generateCertificate: ((id: number) => Promise<<internal>.Blob>)

Type declaration

generateConsultationJitsy: ((consultation: number) => Promise<DefaultResponse<JitsyData>>)

Type declaration

generateWebinarJitsy: ((webinarId: number) => Promise<DefaultResponse<JitsyData>>)

Type declaration

getImagePrefix: (() => string)

Type declaration

    • (): string
    • Returns string

getImageSvgPrefix: (() => string)

Type declaration

    • (): string
    • Returns string

getNextPrevTopic: ((topicId: number, next?: boolean) => null | API.Topic)

Type declaration

    • (topicId: number, next?: boolean): null | API.Topic
    • Parameters

      • topicId: number
      • Optional next: boolean

      Returns null | API.Topic

getProductInfo: ((id: number) => Promise<DefaultResponse<API.Product>>)

Type declaration

getRefreshedToken: (() => Promise<void>)

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

h5pProgress: ((courseId: string, topicId: number, statement: IStatement) => null | Promise<SuccessResponse>)

Type declaration

initAccountDelete: ((returnUrl: string) => Promise<AuthResponse>)

Type declaration

login: ((body: LoginRequest) => Promise<LoginResponse>)

Type declaration

logout: (() => Promise<void>)

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

payWithP24: ((email: string, return_url: string, data?: InvoiceData) => Promise<void>)

Type declaration

    • (email: string, return_url: string, data?: InvoiceData): Promise<void>
    • Parameters

      • email: string
      • return_url: string
      • Optional data: InvoiceData

      Returns Promise<void>

payWithStripe: ((payment_method: string, return_url: string) => Promise<void>)

Type declaration

    • (payment_method: string, return_url: string): Promise<void>
    • Parameters

      • payment_method: string
      • return_url: string

      Returns Promise<void>

readAllNotifications: (() => Promise<void>)

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

readNotify: ((id: string) => Promise<void>)

Type declaration

    • (id: string): Promise<void>
    • Parameters

      • id: string

      Returns Promise<void>

realizeVoucher: ((voucher: string) => Promise<AuthResponse>)

Type declaration

register: ((body: RegisterRequest) => Promise<DefaultResponse<RegisterResponse>>)

Type declaration

rejectConsultationTerm: ((consultation: number) => Promise<void | DefaultResponseError | PaginatedMetaList<AppointmentTerm> & {
    message: string;
    success: true;
} | DefaultResponseSuccess<AppointmentTerm>>)

Type declaration

removeFromCart: ((courseId: number) => Promise<void>)

Type declaration

    • (courseId: number): Promise<void>
    • Parameters

      • courseId: number

      Returns Promise<void>

removeVoucher: (() => Promise<AuthResponse>)

Type declaration

reset: ((body: ResetPasswordRequest) => Promise<AuthResponse>)

Type declaration

resetCart: (() => void)

Type declaration

    • (): void
    • Returns void

sendProgress: ((courseId: number, data: CourseProgressItemElement[]) => Promise<void>)

Type declaration

sendQuestionnaireAnswer: ((model: string, modelID: number, id: number, body: Partial<<internal>.QuestionAnswer>) => Promise<DefaultResponse<<internal>.QuestionAnswer>>)

Type declaration

socialAuthorize: ((token: string) => void)

Type declaration

    • (token: string): void
    • Parameters

      • token: string

      Returns void

subscriptionPayWithP24: ((subId: number, email: string, return_url: string, data?: InvoiceData) => Promise<void>)

Type declaration

    • (subId: number, email: string, return_url: string, data?: InvoiceData): Promise<void>
    • Parameters

      • subId: number
      • email: string
      • return_url: string
      • Optional data: InvoiceData

      Returns Promise<void>

topicIsFinished: ((topicId: number) => <internal>.Boolean)

Type declaration

topicPing: ((topicId: number) => Promise<<internal>.Boolean>)

Type declaration

updateAvatar: ((avatar: <internal>.File) => Promise<DefaultResponse<UserAsProfile>>)

Type declaration

updateBookmarkNote: ((id: number, body: CreateBookmarkNote) => Promise<DefaultResponse<BookmarkNote>>)

Type declaration

updateConsultationAccess: ((id: number, data: ConsultationsAccessEnquiryUpdateRequest) => Promise<DefaultResponse<ConsultationAccessEnquiry>>)
updateProfile: ((data: UpdateUserDetails) => Promise<DefaultResponse<UserAsProfile>>)

Type declaration

updateProfileEmail: ((data: UpdateUserEmail) => Promise<DefaultResponse<UserAsProfile>>)

Type declaration

updateTask: ((id: number, data: UpdateTaskRequest) => Promise<DefaultResponse<API.Task>>)

Type declaration

updateTaskNote: ((id: number, taskNoteId: number, note: string) => Promise<DefaultResponse<API.TaskNote>>)

Type declaration

updateTaskStatus: ((id: number, done: boolean) => Promise<DefaultResponse<API.Task>>)

Type declaration

Generated using TypeDoc