Files
schoolNews/schoolNewsWeb/src/apis/study/learning-task.ts

156 lines
4.9 KiB
TypeScript
Raw Normal View History

2025-10-16 10:45:44 +08:00
/**
* @description API
* @author yslg
* @since 2025-10-15
*/
import { api } from '@/apis/index';
2025-10-22 18:00:27 +08:00
import type { LearningTask, LearningProgress, ResultDomain, PageParam, TaskVO, TaskUser, TaskItemVO } from '@/types';
2025-10-16 10:45:44 +08:00
/**
* API服务
*/
export const learningTaskApi = {
2025-10-22 18:00:27 +08:00
learningTaskPrefix: '/study/tasks',
2025-10-16 10:45:44 +08:00
/**
*
* @param filter
* @returns Promise<ResultDomain<LearningTask>>
*/
async getTaskList(filter?: Partial<LearningTask>): Promise<ResultDomain<LearningTask>> {
2025-10-22 18:00:27 +08:00
const response = await api.get<LearningTask>(`${this.learningTaskPrefix}/list`, filter);
2025-10-16 10:45:44 +08:00
return response.data;
},
/**
* ID获取任务详情
* @param taskID ID
2025-10-22 18:00:27 +08:00
* @returns Promise<ResultDomain<TaskVO>>
2025-10-16 10:45:44 +08:00
*/
2025-10-22 18:00:27 +08:00
async getTaskById(taskID: string): Promise<ResultDomain<TaskVO>> {
const response = await api.get<TaskVO>(`${this.learningTaskPrefix}/${taskID}`);
2025-10-16 10:45:44 +08:00
return response.data;
},
2025-10-24 18:28:35 +08:00
/**
* ID获取用户任务详情
* @param taskID ID
* @returns Promise<ResultDomain<TaskVO>>
*/
async getUserTask(taskID: string): Promise<ResultDomain<TaskVO>> {
const response = await api.get<TaskVO>(`${this.learningTaskPrefix}/${taskID}/user`);
return response.data;
},
2025-10-30 16:40:56 +08:00
async getTaskUsers(taskID: string): Promise<ResultDomain<TaskItemVO>> {
const response = await api.get<TaskItemVO>(`${this.learningTaskPrefix}/${taskID}/users`);
return response.data;
},
2025-10-22 18:00:27 +08:00
/**
*
* @param pageParam
* @param filter
* @returns Promise<ResultDomain<LearningTask>>
*/
async getTaskPage(pageParam: PageParam, filter: LearningTask): Promise<ResultDomain<LearningTask>> {
const response = await api.post<LearningTask>(`${this.learningTaskPrefix}/page`, {pageParam, filter});
return response.data;
},
2025-10-16 10:45:44 +08:00
/**
*
* @param task
2025-10-22 18:00:27 +08:00
* @returns Promise<ResultDomain<TaskVO>>
2025-10-16 10:45:44 +08:00
*/
2025-10-22 18:00:27 +08:00
async createTask(task: TaskVO): Promise<ResultDomain<TaskVO>> {
const response = await api.post<TaskVO>(`${this.learningTaskPrefix}/task`, task);
2025-10-16 10:45:44 +08:00
return response.data;
},
/**
*
* @param task
2025-10-22 18:00:27 +08:00
* @returns Promise<ResultDomain<TaskVO>>
2025-10-16 10:45:44 +08:00
*/
2025-10-22 18:00:27 +08:00
async updateTask(task: TaskVO): Promise<ResultDomain<TaskVO>> {
const response = await api.put<TaskVO>(`${this.learningTaskPrefix}/task`, task);
2025-10-16 10:45:44 +08:00
return response.data;
},
/**
*
* @param taskID ID
* @returns Promise<ResultDomain<boolean>>
*/
async deleteTask(taskID: string): Promise<ResultDomain<boolean>> {
2025-10-28 19:04:35 +08:00
const response = await api.delete<boolean>(`${this.learningTaskPrefix}/task`, {taskID});
2025-10-16 10:45:44 +08:00
return response.data;
},
/**
2025-10-29 19:08:22 +08:00
* \
2025-10-16 10:45:44 +08:00
* @param taskID ID
* @returns Promise<ResultDomain<LearningTask>>
*/
2025-10-29 19:08:22 +08:00
async changeTaskStatus(task: LearningTask): Promise<ResultDomain<LearningTask>> {
2025-10-22 18:00:27 +08:00
const response = await api.put<LearningTask>(`${this.learningTaskPrefix}/status`, task);
2025-10-16 10:45:44 +08:00
return response.data;
},
/**
*
* @param userID ID
* @param taskID ID
* @returns Promise<ResultDomain<LearningProgress>>
*/
async getUserTaskProgress(userID: string, taskID: string): Promise<ResultDomain<LearningProgress>> {
2025-10-22 18:00:27 +08:00
const response = await api.get<LearningProgress>(`${this.learningTaskPrefix}/task/${taskID}/progress`, {
2025-10-16 10:45:44 +08:00
userID
});
return response.data;
2025-10-22 18:00:27 +08:00
},
/**
*
* @param taskID ID
* @param userID ID
* @returns Promise<ResultDomain<TaskUser>>
*/
async assignTaskToUser(taskID: string, userID: string): Promise<ResultDomain<TaskUser>> {
const response = await api.post<TaskUser>(`${this.learningTaskPrefix}/${taskID}/assign`, null, {
params: { userID }
});
return response.data;
},
/**
*
* @param taskID ID
* @param userID ID
* @returns Promise<ResultDomain<boolean>>
*/
async removeTaskFromUser(taskID: string, userID: string): Promise<ResultDomain<boolean>> {
const response = await api.delete<boolean>(`${this.learningTaskPrefix}/${taskID}/user/${userID}`);
return response.data;
},
/**
*
* @param pageParam
* @param filter
* @returns Promise<ResultDomain<LearningTask>>
*/
async getUserTaskPage(pageParam: PageParam, filter?: TaskItemVO): Promise<ResultDomain<LearningTask>> {
const response = await api.post<LearningTask>(`${this.learningTaskPrefix}/users/page`, {
pageParam,
filter
});
return response.data;
2025-10-23 18:57:31 +08:00
},
async getUserProgress(userID: string): Promise<ResultDomain<TaskVO>> {
const response = await api.post<TaskVO>(`${this.learningTaskPrefix}/user/progress/${userID}`);
return response.data;
},
2025-10-16 10:45:44 +08:00
};