Skip to content

Commit 728daba

Browse files
[auto-generated] Update structure file for main
1 parent b8c3070 commit 728daba

File tree

1 file changed

+0
-344
lines changed

1 file changed

+0
-344
lines changed

structure/main.ts

Lines changed: 0 additions & 344 deletions
Original file line numberDiff line numberDiff line change
@@ -8906,240 +8906,6 @@ export type AddonModBookViewBookWSResponse = {
89068906
warnings?: CoreWSExternalWarning[];
89078907
};
89088908

8909-
/**
8910-
* Params of mod_chat_get_chat_latest_messages WS.
8911-
*
8912-
* WS Description: Get the latest messages from the given chat session.
8913-
*/
8914-
type AddonModChatGetChatLatestMessagesWSParams = {
8915-
chatsid: string; // Chat session id (obtained via mod_chat_login_user).
8916-
chatlasttime?: number; // Last time messages were retrieved (epoch time).
8917-
};
8918-
8919-
/**
8920-
* Data returned by mod_chat_get_chat_latest_messages WS.
8921-
*
8922-
* WS Description: Get the latest messages from the given chat session.
8923-
*/
8924-
export type AddonModChatGetChatLatestMessagesWSResponse = {
8925-
messages: { // List of users.
8926-
id: number; // Message id.
8927-
userid: number; // User id.
8928-
system: boolean; // True if is a system message (like user joined).
8929-
message: string; // Message text.
8930-
timestamp: number; // Timestamp for the message.
8931-
}[];
8932-
chatnewlasttime: number; // New last time.
8933-
warnings?: CoreWSExternalWarning[];
8934-
};
8935-
8936-
/**
8937-
* Params of mod_chat_get_chats_by_courses WS.
8938-
*
8939-
* WS Description: Returns a list of chat instances in a provided set of courses,
8940-
if no courses are provided then all the chat instances the user has access to will be returned.
8941-
*/
8942-
type AddonModChatGetChatsByCoursesWSParams = {
8943-
courseids?: number[]; // Array of course ids.
8944-
};
8945-
8946-
/**
8947-
* Data returned by mod_chat_get_chats_by_courses WS.
8948-
*
8949-
* WS Description: Returns a list of chat instances in a provided set of courses,
8950-
if no courses are provided then all the chat instances the user has access to will be returned.
8951-
*/
8952-
export type AddonModChatGetChatsByCoursesWSResponse = {
8953-
chats: {
8954-
id: number; // Activity instance id.
8955-
coursemodule: number; // Course module id.
8956-
course: number; // Course id.
8957-
name: string; // Activity name.
8958-
intro: string; // Activity introduction.
8959-
introformat: number; // Intro format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN).
8960-
introfiles?: CoreWSExternalFile[];
8961-
section?: number; // Course section id.
8962-
visible?: boolean; // Visible.
8963-
groupmode?: number; // Group mode.
8964-
groupingid?: number; // Group id.
8965-
lang?: string; // Forced activity language.
8966-
chatmethod?: string; // Chat method (sockets, ajax, header_js).
8967-
keepdays?: number; // Keep days.
8968-
studentlogs?: number; // Student logs visible to everyone.
8969-
chattime?: number; // Chat time.
8970-
schedule?: number; // Schedule type.
8971-
timemodified?: number; // Time of last modification.
8972-
}[];
8973-
warnings?: CoreWSExternalWarning[];
8974-
};
8975-
8976-
/**
8977-
* Params of mod_chat_get_chat_users WS.
8978-
*
8979-
* WS Description: Get the list of users in the given chat session.
8980-
*/
8981-
type AddonModChatGetChatUsersWSParams = {
8982-
chatsid: string; // Chat session id (obtained via mod_chat_login_user).
8983-
};
8984-
8985-
/**
8986-
* Data returned by mod_chat_get_chat_users WS.
8987-
*
8988-
* WS Description: Get the list of users in the given chat session.
8989-
*/
8990-
export type AddonModChatGetChatUsersWSResponse = {
8991-
users: { // List of users.
8992-
id: number; // User id.
8993-
fullname: string; // User full name.
8994-
profileimageurl: string; // User picture URL.
8995-
}[];
8996-
warnings?: CoreWSExternalWarning[];
8997-
};
8998-
8999-
/**
9000-
* Params of mod_chat_get_session_messages WS.
9001-
*
9002-
* WS Description: Retrieves messages of the given chat session.
9003-
*/
9004-
type AddonModChatGetSessionMessagesWSParams = {
9005-
chatid: number; // Chat instance id.
9006-
sessionstart: number; // The session start time (timestamp).
9007-
sessionend: number; // The session end time (timestamp).
9008-
groupid?: number; // Get messages from users in this group.
9009-
// 0 means that the function will determine the user group.
9010-
9011-
};
9012-
9013-
/**
9014-
* Data returned by mod_chat_get_session_messages WS.
9015-
*
9016-
* WS Description: Retrieves messages of the given chat session.
9017-
*/
9018-
export type AddonModChatGetSessionMessagesWSResponse = {
9019-
messages: {
9020-
id: number; // The message record id.
9021-
chatid: number; // The chat id.
9022-
userid: number; // The user who wrote the message.
9023-
groupid: number; // The group this message belongs to.
9024-
issystem: boolean; // Whether is a system message or not.
9025-
message: string; // The message text.
9026-
timestamp: number; // The message timestamp (indicates when the message was sent).
9027-
}[];
9028-
warnings?: CoreWSExternalWarning[];
9029-
};
9030-
9031-
/**
9032-
* Params of mod_chat_get_sessions WS.
9033-
*
9034-
* WS Description: Retrieves chat sessions for a given chat.
9035-
*/
9036-
type AddonModChatGetSessionsWSParams = {
9037-
chatid: number; // Chat instance id.
9038-
groupid?: number; // Get messages from users in this group.
9039-
// 0 means that the function will determine the user group.
9040-
9041-
showall?: boolean; // Whether to show completed sessions or not.
9042-
};
9043-
9044-
/**
9045-
* Data returned by mod_chat_get_sessions WS.
9046-
*
9047-
* WS Description: Retrieves chat sessions for a given chat.
9048-
*/
9049-
export type AddonModChatGetSessionsWSResponse = {
9050-
sessions: { // List of users.
9051-
sessionstart: number; // Session start time.
9052-
sessionend: number; // Session end time.
9053-
sessionusers: { // Session users.
9054-
userid: number; // User id.
9055-
messagecount: number; // Number of messages in the session.
9056-
}[];
9057-
iscomplete: boolean; // Whether the session is completed or not.
9058-
}[];
9059-
warnings?: CoreWSExternalWarning[];
9060-
};
9061-
9062-
/**
9063-
* Params of mod_chat_login_user WS.
9064-
*
9065-
* WS Description: Log a user into a chat room in the given chat.
9066-
*/
9067-
type AddonModChatLoginUserWSParams = {
9068-
chatid: number; // Chat instance id.
9069-
groupid?: number; // Group id, 0 means that the function will determine the user group.
9070-
};
9071-
9072-
/**
9073-
* Data returned by mod_chat_login_user WS.
9074-
*
9075-
* WS Description: Log a user into a chat room in the given chat.
9076-
*/
9077-
export type AddonModChatLoginUserWSResponse = {
9078-
chatsid: string; // Unique chat session id.
9079-
warnings?: CoreWSExternalWarning[];
9080-
};
9081-
9082-
/**
9083-
* Params of mod_chat_send_chat_message WS.
9084-
*
9085-
* WS Description: Send a message on the given chat session.
9086-
*/
9087-
type AddonModChatSendChatMessageWSParams = {
9088-
chatsid: string; // Chat session id (obtained via mod_chat_login_user).
9089-
messagetext: string; // The message text.
9090-
beepid?: string; // The beep id.
9091-
};
9092-
9093-
/**
9094-
* Data returned by mod_chat_send_chat_message WS.
9095-
*
9096-
* WS Description: Send a message on the given chat session.
9097-
*/
9098-
export type AddonModChatSendChatMessageWSResponse = {
9099-
messageid: number; // Message sent id.
9100-
warnings?: CoreWSExternalWarning[];
9101-
};
9102-
9103-
/**
9104-
* Params of mod_chat_view_chat WS.
9105-
*
9106-
* WS Description: Trigger the course module viewed event and update the module completion status.
9107-
*/
9108-
type AddonModChatViewChatWSParams = {
9109-
chatid: number; // Chat instance id.
9110-
};
9111-
9112-
/**
9113-
* Data returned by mod_chat_view_chat WS.
9114-
*
9115-
* WS Description: Trigger the course module viewed event and update the module completion status.
9116-
*/
9117-
export type AddonModChatViewChatWSResponse = {
9118-
status: boolean; // Status: true if success.
9119-
warnings?: CoreWSExternalWarning[];
9120-
};
9121-
9122-
/**
9123-
* Params of mod_chat_view_sessions WS.
9124-
*
9125-
* WS Description: Trigger the chat session viewed event.
9126-
*/
9127-
type AddonModChatViewSessionsWSParams = {
9128-
cmid: number; // Course module id.
9129-
start?: number; // Session start time.
9130-
end?: number; // Session end time.
9131-
};
9132-
9133-
/**
9134-
* Data returned by mod_chat_view_sessions WS.
9135-
*
9136-
* WS Description: Trigger the chat session viewed event.
9137-
*/
9138-
export type AddonModChatViewSessionsWSResponse = {
9139-
status: boolean; // Status: true if success.
9140-
warnings?: CoreWSExternalWarning[];
9141-
};
9142-
91438909
/**
91448910
* Params of mod_choice_delete_choice_responses WS.
91458911
*
@@ -14940,116 +14706,6 @@ export type AddonModScormViewScormWSResponse = {
1494014706
warnings?: CoreWSExternalWarning[];
1494114707
};
1494214708

14943-
/**
14944-
* Params of mod_survey_get_questions WS.
14945-
*
14946-
* WS Description: Get the complete list of questions for the survey, including subquestions.
14947-
*/
14948-
type AddonModSurveyGetQuestionsWSParams = {
14949-
surveyid: number; // Survey instance id.
14950-
};
14951-
14952-
/**
14953-
* Data returned by mod_survey_get_questions WS.
14954-
*
14955-
* WS Description: Get the complete list of questions for the survey, including subquestions.
14956-
*/
14957-
export type AddonModSurveyGetQuestionsWSResponse = {
14958-
questions: {
14959-
id: number; // Question id.
14960-
text: string; // Question text.
14961-
shorttext: string; // Question short text.
14962-
multi: string; // Subquestions ids.
14963-
intro: string; // The question intro.
14964-
type: number; // Question type.
14965-
options: string; // Question options.
14966-
parent: number; // Parent question (for subquestions).
14967-
}[];
14968-
warnings?: CoreWSExternalWarning[];
14969-
};
14970-
14971-
/**
14972-
* Params of mod_survey_get_surveys_by_courses WS.
14973-
*
14974-
* WS Description: Returns a list of survey instances in a provided set of courses,
14975-
if no courses are provided then all the survey instances the user has access to will be returned.
14976-
*/
14977-
type AddonModSurveyGetSurveysByCoursesWSParams = {
14978-
courseids?: number[]; // Array of course ids.
14979-
};
14980-
14981-
/**
14982-
* Data returned by mod_survey_get_surveys_by_courses WS.
14983-
*
14984-
* WS Description: Returns a list of survey instances in a provided set of courses,
14985-
if no courses are provided then all the survey instances the user has access to will be returned.
14986-
*/
14987-
export type AddonModSurveyGetSurveysByCoursesWSResponse = {
14988-
surveys: {
14989-
id: number; // Activity instance id.
14990-
coursemodule: number; // Course module id.
14991-
course: number; // Course id.
14992-
name: string; // Activity name.
14993-
intro?: string; // Activity introduction.
14994-
introformat?: number; // Intro format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN).
14995-
introfiles?: CoreWSExternalFile[];
14996-
section?: number; // Course section id.
14997-
visible?: boolean; // Visible.
14998-
groupmode?: number; // Group mode.
14999-
groupingid?: number; // Group id.
15000-
lang?: string; // Forced activity language.
15001-
template?: number; // Survey type.
15002-
days?: number; // Days.
15003-
questions?: string; // Question ids.
15004-
surveydone?: number; // Did I finish the survey?.
15005-
timecreated?: number; // Time of creation.
15006-
timemodified?: number; // Time of last modification.
15007-
}[];
15008-
warnings?: CoreWSExternalWarning[];
15009-
};
15010-
15011-
/**
15012-
* Params of mod_survey_submit_answers WS.
15013-
*
15014-
* WS Description: Submit the answers for a given survey.
15015-
*/
15016-
type AddonModSurveySubmitAnswersWSParams = {
15017-
surveyid: number; // Survey id.
15018-
answers: {
15019-
key: string; // Answer key.
15020-
value: string; // Answer value.
15021-
}[];
15022-
};
15023-
15024-
/**
15025-
* Data returned by mod_survey_submit_answers WS.
15026-
*
15027-
* WS Description: Submit the answers for a given survey.
15028-
*/
15029-
export type AddonModSurveySubmitAnswersWSResponse = {
15030-
status: boolean; // Status: true if success.
15031-
warnings?: CoreWSExternalWarning[];
15032-
};
15033-
15034-
/**
15035-
* Params of mod_survey_view_survey WS.
15036-
*
15037-
* WS Description: Trigger the course module viewed event and update the module completion status.
15038-
*/
15039-
type AddonModSurveyViewSurveyWSParams = {
15040-
surveyid: number; // Survey instance id.
15041-
};
15042-
15043-
/**
15044-
* Data returned by mod_survey_view_survey WS.
15045-
*
15046-
* WS Description: Trigger the course module viewed event and update the module completion status.
15047-
*/
15048-
export type AddonModSurveyViewSurveyWSResponse = {
15049-
status: boolean; // Status: true if success.
15050-
warnings?: CoreWSExternalWarning[];
15051-
};
15052-
1505314709
/**
1505414710
* Params of mod_url_get_urls_by_courses WS.
1505514711
*

0 commit comments

Comments
 (0)