jcbpm-vue
Version:
jcbpm-vue
283 lines (282 loc) • 9.85 kB
TypeScript
import { GetHistoryRecordsListParamsModel } from '../api/task-operation/model';
import { ResponseObject, HandlePersonList, CurrentNodeInfo, NextNodeInfo, NextTasksNode, HistoryNodeInfo, TasksJumpNodes, TasksSignUsers, HistoryRecordsList } from '../types/task-operation';
export declare class TaskOperationApi {
name: string;
constructor();
/**
* 初始化
* @param params AuthenticationToken 嘉诚统一账号鉴权管理系统的接口地址返回token
* @param params BpmRequestPrefix 服务接口地址
* @param params RbacRequestPrefix 嘉诚统一账号鉴权管理系统的接口地址
* @returns boolean
*/
initConfiguration(params: {
AuthenticationToken: Function;
BpmRequestPrefix: string;
RbacRequestPrefix: string;
}): boolean;
/**
* 销毁【删除localStorage缓存】
* @returns boolean
*/
destoryConfiguration(): boolean;
/**
* 获取办理人员信息
* @param applicationId 应用Id
* @returns Promise<HandlePersonList[]|[]>
*/
getHandlePersonList(applicationId: string): Promise<HandlePersonList[]>;
/**
* 获取当前节点信息
* @param params taskId 任务Id
* @param params customParam:流程参数
* @param params operate:操作类型,待办:TODO(默认);已办:DONE
* @returns Promise<CurrentNodeInfo>
*/
getCurrentNodeInfo(params: {
taskId: string;
params: {
customParam?: {
[propname: string]: string;
};
operate?: string;
};
}): Promise<CurrentNodeInfo>;
/**
* 获取下一个节点信息(发起时)
* @param params flowId 流程Id
* @param params customParam 流程参数
* @returns Promise<NextNodeInfo[]>
*/
getNextNodeInfo(params: {
flowId: string;
customParam?: {
[propname: string]: string | number;
};
}): Promise<NextNodeInfo[]>;
/**
* 获取下一个节点信息(办理时)
* @param params taskId 任务Id
* @param params type 人员信息类型,user、dept、role、relation、post,默认值:user
* @param params formParamsData 表单数据
* @returns Promise<NextTasksNode[]>
*/
getNextTasksNode(params: {
taskId: string;
type?: string[];
formParamsData?: {
[propname: string]: string | number;
};
}): Promise<NextTasksNode[]>;
/**
* 获取历史节点信息
* @param taskId 任务Id
* @returns Promise<HistoryNodeInfo[]>
*/
getHistoryNodeInfo(taskId: string): Promise<HistoryNodeInfo[]>;
/**
* 获取可跳转的节点信息
* @param taskId 任务Id
* @param params object 表单数据
* @returns Promise<TasksJumpNodes[]>
*/
getTasksJumpNodes(taskId: string, params: {
[propname: string]: string | number;
}): Promise<TasksJumpNodes[]>;
/**
* 查询可减签、加签的人员信息
* @param procInstId 实例Id
* @param params nodeId 节点Id
* @param params nodeType 查询当前节点信息返回的 type字段
* @returns Promise<TasksSignUsers[]>
*/
getTasksSignUsers(procInstId: string, params: {
nodeId?: string;
nodeType?: string;
}): Promise<TasksSignUsers[]>;
/**
* 获取历史节点操作记录信息 (businessKey)
* @param businessKey 业务Id
* @returns Promise<HistoryRecordsList[]>
*/
getHistoryRecordsList(params: GetHistoryRecordsListParamsModel): Promise<HistoryRecordsList[]>;
/**
* 加签
* @param params confirmNodeI 办理人Id
* @param params confirmUserId 办理节点Id
* @param params confirmNodeName 办理节点名称
* @param params confirmUserName 办理人名称
* @param params procInstId 在办箱列表的 processInstanceId字段 实例Id
* @param params taskId 在办箱列表的 id字段 任务Id
* @returns Promise<ResponseObject>
*/
taskAddSign(params: {
confirmNodeId?: string;
confirmUserId?: string;
confirmNodeName?: string;
confirmUserName?: string;
procInstId?: string;
taskId?: string;
}): Promise<ResponseObject>;
/**
* 指派处理人
* @param taskId 在办箱列表的 id字段 任务Id
* @param params confirmUserId 办理人Id
* @param params confirmUserName 办理人名称
* @returns Promise<ResponseObject>
*/
taskClaim(taskId: string, params: {
confirmUserId?: string;
confirmUserName?: string;
}): Promise<ResponseObject>;
/**
* 委派
* @param taskId 在办箱列表的 id字段 任务Id
* @param params confirmUserId 办理人Id
* @param params confirmUserName 办理人名称
* @returns Promise<ResponseObject>
*/
taskDelegates(taskId: string, params: {
confirmUserId?: string;
confirmUserName?: string;
}): Promise<ResponseObject>;
/**
* 办理任务
* @param taskId 在办箱列表的 id字段 任务Id
* @param params resolved number 委托任务完成方式,0直接完成任务,1返回到委托人,默认 0
* @param params message 处理意见
* @param params params 表单数据
* @returns Promise<ResponseObject>
*/
taskhandle(taskId: string, params: {
resolved?: number;
message?: string;
params?: {
[propname: string]: string | number;
};
}): Promise<ResponseObject>;
/**
* 跳转
* @param taskId 在办箱列表的 id字段 任务Id
* @param params message s处理意见
* @param params confirmUserName 办理人名称
* @param params confirmUserId 办理人Id
* @param params confirmNodeName 办理节点名称
* @param params confirmNodeId 办理节点Id
* @param params currentNodeId 当前节点Id
* @returns Promise<ResponseObject>
*/
taskJump(taskId: string, params: {
currentNodeId?: string;
confirmNodeId?: string;
confirmNodeName?: string;
confirmUserId?: string;
confirmUserName?: string;
message?: string;
}): Promise<ResponseObject>;
/**
* 发起流程
* @param params instanceName 实例名称
* @param params flowID 流程标识
* @param params params 流程参数
* @param params autoComplete 是否跳过第一节点,yes:跳过;no:不跳过默认值yes
* @returns Promise<ResponseObject>
*/
processLaunch(params: {
instanceName?: string;
flowID?: string;
params?: {
[propname: string]: string | number;
};
autoComplete?: string;
}): Promise<ResponseObject>;
/**
* 退回历史节点
* @param taskId 任务Id
* @param params confirmUserId 历史处理人Id
* @param params confirmUserName 历史处理人姓名
* @param params confirmNodeId 节点Id
* @param params confirmNodeName 节点名称
* @param params message 处理意见
* @param params submitType 任务办理类型 默认 reject
* @returns Promise<ResponseObject>
*/
taskRejectToHistoryNode(taskId: string, params: {
confirmNodeId?: string;
confirmNodeName?: string;
confirmUserId?: string;
confirmUserName?: string;
message?: string;
submitType?: string;
}): Promise<ResponseObject>;
/**
* 退回上一节点
* @param taskId 任务Id
* @param params confirmUserId 历史处理人Id
* @param params confirmUserName 历史处理人姓名
* @param params confirmNodeId 节点Id
* @param params confirmNodeName 节点名称
* @param params message 处理意见
* @param params submitType 任务办理类型 默认 reject
* @returns Promise<ResponseObject>
*/
taskRejectLastNode(taskId: string, params: {
confirmNodeId?: string;
confirmNodeName?: string;
confirmUserId?: string;
confirmUserName?: string;
message?: string;
submitType?: string;
}): Promise<ResponseObject>;
/**
* 减签
* @param params taskId 任务Id
* @param params procInstId 在办箱列表的 processInstanceId字段 实例Id
* @param params confirmUserId 办理人Id
* @param params confirmUserName 办理人姓名
* @param params confirmNodeId 办理节点Id
* @param params confirmNodeName 办理节点名称
* @returns Promise<ResponseObject>
*/
taskSubSign(params: {
confirmNodeId?: string;
confirmUserId?: string;
confirmNodeName?: string;
confirmUserName?: string;
procInstId?: string;
taskId?: string;
}[]): Promise<ResponseObject>;
/**
* 拿回
* @param instanceId 流程Id
* @param params confirmNodeId 办理节点Id
* @param params confirmUserId 办理人Id
* @param params message 处理意见
* @returns Promise<ResponseObject>
*/
taskTakeBack(instanceId: string, params: {
confirmNodeId?: string;
confirmUserId?: string;
message?: string;
}): Promise<ResponseObject>;
/**
* 终止任务
* @param taskId 任务Id
* @param params message 处理意见
* @returns Promise<ResponseObject>
*/
taskTerminate(taskId: string, params: {
message?: string;
}): Promise<ResponseObject>;
/**
* 转办
* @param taskId 任务Id
* @param params confirmUserId 办理人Id
* @param params confirmUserName 办理人名称
* @returns Promise<ResponseObject>
*/
taskTransfer(taskId: string, params: {
confirmUserId?: string;
confirmUserName?: string;
}): Promise<ResponseObject>;
}