@boristype/types
Version:
<h1 align="center">WT Types</h1> <div align="center"> Typescript типы для WebSoft HCM.
292 lines (286 loc) • 9.69 kB
TypeScript
interface CourseDocumentPartActivityState {
/** Статус учебной активности */
activity_state_id: XmlElem<number | null, ActivityStateCatalogDocumentTopElem>;
/** Баллы */
score: XmlElem<number | null>;
/** Состояние */
state_id: XmlElem<number | null, typeof common.learning_states>;
}
interface CourseDocumentPartCompletedParentPart {
part_code: XmlElem<string | null>;
}
interface CourseDocumentPart {
/** Код */
code: XmlElem<string | null>;
/** Название */
name: XmlElem<string | null>;
/**
* Тип раздела
* @default lesson
*/
type: XmlElem<string, typeof common.course_part_types>;
/** Максимальный балл */
max_score: XmlElem<number | null>;
/** Проходной балл */
mastery_score: XmlElem<number | null>;
/** Относительный проходной балл */
mastery_score_relative: XmlElem<number | null>;
/** URL */
url: XmlElem<string | null>;
/** Учебный модуль */
course_module_id: XmlElem<number | null, CourseModuleCatalogDocumentTopElem>;
/** Родительский раздел */
parent_part_code: XmlElem<string | null>;
/** Описание */
desc: XmlElem<string | null>;
/** Ширина */
win_width: XmlElem<number | null>;
/** Высота */
win_height: XmlElem<number | null>;
/**
* Отображать scrolling
* @default false
*/
disp_scrolling: XmlElem<boolean>;
/**
* Возможно изменять размер
* @default false
*/
resizable: XmlElem<boolean>;
/**
* Обязательный раздел
* @default true
*/
is_mandatory: XmlElem<boolean>;
/**
* Видимый раздел
* @default true
*/
is_visible: XmlElem<boolean>;
/** Максимальное время на модуль */
max_time_allowed: XmlElem<string | null>;
/** Действие по наступлению лимита времени */
time_limit_action: XmlElem<string | null>;
/**
* Установка статуса
* @default course
*/
set_status_side: XmlElem<string>;
/**
* Коэффициент итоговой оценки
* @default 1.0
*/
score_factor: XmlElem<number>;
/** Тест */
assessment_id: XmlElem<number | null, QtiAssessmentCatalogDocumentTopElem>;
/**
* Количество попыток
* @default 1
*/
attempts_num: XmlElem<number>;
/** День планируемого начала обучения */
start_day: XmlElem<number | null>;
/** Планируемая продолжительность обучения в днях */
duration_day: XmlElem<number | null>;
/** Учебная активность */
activity_id: XmlElem<number | null, ActivityCatalogDocumentTopElem>;
activity_states: XmlMultiElem<CourseDocumentPartActivityState | null>;
object_id: XmlElem<number | null>;
/** Представление */
cl_module_view: XmlElem<string | null>;
/** Доступ после завершения разделов */
completed_parent_parts: XmlMultiElem<CourseDocumentPartCompletedParentPart | null>;
view: XmlElem<ViewConditionsBase | null>;
launch: XmlElem<ViewConditionsBase | null>;
/** Протокол */
cl_module_protocol: XmlElem<string | null>;
}
interface CourseDocumentView extends DescBase {
/**
* @temp
* @default 0
*/
part_index: XmlElem<number>;
/** @temp */
filter: XmlElem<AuFtFilter | null>;
/**
* @temp
* Классификатор
*/
knowledge_classifier_id: XmlElem<number | null>;
/**
* @temp
* Сортировать по
* @default name
*/
knowledge_sort_type_id: XmlElem<string | null>;
}
type CourseDocumentTopElem = XmlTopElem &
ObjectCodeNameBase &
EstimationLevelsBase &
CourseExpertsBase &
CourseSettingsBase &
CatalogListBase &
FileListBase &
KnowledgePartsBase &
KnowledgePartsBaseOld &
ProctoringBase &
GameBonusBase &
CustomElemsBase &
AdminAccessBase & {
Doc: CourseDocument;
/** Описание */
desc: XmlElem<string | null>;
/** @default publish */
status: XmlElem<string, typeof common.course_test_states>;
/** Ширина окна электронного курса */
win_width: XmlElem<number | null>;
/** Высота окна электронного курса */
win_height: XmlElem<number | null>;
/**
* Отображать скроллбар
* @default false
*/
disp_scrolling: XmlElem<boolean>;
/**
* Возможно изменять размер
* @default false
*/
resizable: XmlElem<boolean>;
/** @default fix */
struct_type: XmlElem<string>;
/** Ссылка на файл библиотеки функций */
library_url: XmlElem<string | null>;
/** Разделы электронного курса */
parts: XmlMultiElem<CourseDocumentPart | null>;
/** @default active_learning */
course_finish_redirect: XmlElem<string>;
course_finish_redirect_url: XmlElem<string | null>;
/** Базовый url */
base_url: XmlElem<string | null>;
/**
* Тип плеера курсов
* @default player
*/
view_type: XmlElem<string>;
/** Проходной балл */
mastery_score: XmlElem<number | null>;
/**
* Максимальный балл
* @default 0
*/
max_score: XmlElem<number>;
/**
* Способ расчета итоговой оценки
* @default score
*/
score_sum_type: XmlElem<string>;
/**
* Формула итоговой оценки
* @default score
*/
score_sum_eval: XmlElem<string>;
/**
* Разрешить самостоятельное назначение курса
* @default true
*/
yourself_start: XmlElem<boolean>;
/**
* Разрешить завершать курс, если не все главы пройдены или не набран проходной балл
* @default false
*/
finish_without_mastery_score: XmlElem<boolean>;
/**
* Завершать курс, если пройдены все главы курса или набран проходной балл
* @default false
*/
auto_finish: XmlElem<boolean>;
/**
* Учитывать статус failed от курса для его завершения
* @default true
*/
ignore_failed_for_finish: XmlElem<boolean>;
/**
* Не использовать локальное расположение данного курса
* @default false
*/
ignor_location: XmlElem<boolean>;
/**
* Возможен запуск завершенного курса без сохранения новых результатов
* @default false
*/
start_after_finish: XmlElem<boolean>;
/**
* Не передавать в адресе запускаемого модуля информацию
* @default true
*/
no_url_info: XmlElem<boolean>;
/**
* Открывать описание раздела с типом папка
* @default false
*/
disp_folder_desc: XmlElem<boolean>;
/** Продолжительность */
duration: XmlElem<number | null>;
/**
* Не кодировать данные модулей при запуска курса
* @default false
*/
no_encoding_core_lesson: XmlElem<boolean | null>;
/**
* Не отправлять стандартные уведомления о назначении
* @default false
*/
not_use_default_notification: XmlElem<boolean | null>;
/** Тип отзыва по умолчанию */
default_response_type_id: XmlElem<number | null, ResponseTypeCatalogDocumentTopElem>;
/**
* Обязательное заполнение отзыва
* @default false
*/
mandatory_fill_response: XmlElem<boolean>;
/**
* Отображать отзывы
* @default false
*/
allow_disp_response: XmlElem<boolean>;
/** Электронный курс */
cl_course_id: XmlElem<number | null, ClCourseCatalogDocumentTopElem>;
version: XmlElem<string | null>;
/** Стоимость записи на электронный курс */
price: XmlElem<number | null>;
/**
* Доступный для Personal WebSoft HCM
* @default false
*/
pwt_disp: XmlElem<boolean>;
import_type: XmlElem<string | null>;
/** Обучающая организация */
education_org_id: XmlElem<number | null, EducationOrgCatalogDocumentTopElem>;
/** Расписание прохождения */
schedule: XmlElem<MsWeekScheduleBase | null>;
/** Доступ */
access: XmlElem<AccessDocBase | null>;
/** Информация об объекте */
doc_info: XmlElem<DocInfoBase | null>;
/** Комментарий */
comment: XmlElem<string | null>;
/** @temp */
view: XmlElem<CourseDocumentView | null>;
get_part_code(): string;
Width(code: string): number;
Height(code: string): number;
DispScrolling(code: unknown): boolean;
Resizable(code: unknown): boolean;
get_workflow_id(): null;
get_pwt_info(source: unknown): string;
GetPartUrl(code: unknown, index: unknown): string;
get_info(): null | Object;
/** Категория */
role_id: XmlMultiElemObject<number | null, RoleCatalogDocumentTopElem>;
};
type CourseDocument = XmlDocument & {
TopElem: CourseDocumentTopElem;
course: CourseDocumentTopElem;
DocDesc(): string;
};