WeComTools | kdayun 界面引擎API

企业微信工具组件签名获取企业的部门,人员,打卡资料,发送消息给人员

Hierarchy

InvisibleBase
- WeComTools

Index

Constructors

constructor

Properties

Constructors

constructor

new WeComTools(config: any): WeComTools

- Defined in YH-Moble/src/wecom/WeComTools.ts:788
Parameters
- config: any
Returns WeComTools

Properties

Private accessToken

accessToken: string

agentId

agentId: string

应用的agentId

orgId

orgId: string

机构id

Methods

ajax

ajax(url: string, type?: MethodType, param?: any, async?: boolean, callback?: WxCpAjaxHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1191
企业微信工具封装好的ajax请求; 如果没有存在access_token会自动取请求access_token; 由于浏览器跨域请求限制,该函数会通过后台服务器做代理中转.详细的代理配置见后台文件application-proxy.yml; 所有的 /cgi-bin/* 都会转发到https://qyapi.weixin.qq.com/cgi-bin ; 注意: 该函数只支持https://qyapi.weixin.qq.com/cgi-bin 开头的URL

Parameters
- url: string
  
  请求地址
- type: MethodType = ...
  
  可选参数. 请求的类型默认 POST
- param: any = ...
  
  可选参数. 参数对象
- async: boolean = true
  
  可选参数. 是否异步请求默认true, false 为同步方式
- Optional callback: WxCpAjaxHandle
  可选参数. 完成后的回调函数
```
// api地址 :https://developer.work.weixin.qq.com/document/path/90262
btn.getPage().components.WeComTools1.ajax('https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckindata',
"POST",
{
opencheckindatatype: 3,
starttime: '1648779622',
endtime: '1651285222',
useridlist: ['FengPingXinJing']
},
true,
function (res, err) {
if (Common.isEmpty(err)) {
console.info(JSON.stringify(res));
} else {
console.info(err);
}
})
```
Returns void

Private formatDate

formatDate(date: any): string

- Defined in YH-Moble/src/wecom/WeComTools.ts:798
Parameters
- date: any
Returns string

getAccessToken

getAccessToken(callback?: WxCpAccessTokenHandle): string

- Defined in YH-Moble/src/wecom/WeComTools.ts:859
获取企业微信的access_token

Parameters
- Optional callback: WxCpAccessTokenHandle
  
  完成回调
Returns string

返回accessToken字符串

getApprovalDetail

getApprovalDetail(spNo: string, callback?: WxApprovalDetailHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:992
获取审批申请详情企业可通过审批应用或自建应用Secret调用本接口，根据审批单号查询企业微信“审批应用”的审批申请详情。 API doc : https://work.weixin.qq.com/api/doc/90000/90135/91983

Parameters
- spNo: string
  
  审批单编号。
- Optional callback: WxApprovalDetailHandle
  
  可选参数. 完成回调
Returns void

getApprovalNos

getApprovalNos(startTime: string, endTime: string, cursor: number, size: number, filters?: IWxCpApprovalInfoQueryFilter[], callback?: WxApprovalNosHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:956
批量获取审批单号

审批应用及有权限的自建应用，可通过Secret调用本接口，以获取企业一段时间内企业微信“审批应用”单据的审批编号，支持按模板类型、申请人、部门、申请单审批状态等条件筛选。自建应用调用此接口，需在“管理后台-应用管理-审批-API-审批数据权限”中，授权应用允许提交审批单据。

一次拉取调用最多拉取100个审批记录，可以通过多次拉取的方式来满足需求，但调用频率不可超过600次/分。

API doc : https://work.weixin.qq.com/api/doc/90000/90135/91816

Parameters
- startTime: string
  
  开始时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-04-01'
- endTime: string
  
  结束时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-04-01'
- cursor: number
  
  分页查询游标，默认为0，后续使用返回的next_cursor进行分页拉取
- size: number
  
  一次请求拉取审批单数量，默认值为100，上限值为100
- filters: IWxCpApprovalInfoQueryFilter[] = ...
  
  筛选条件，可对批量拉取的审批申请设置约束条件，支持设置多个条件,
- Optional callback: WxApprovalNosHandle
  
  可选参数. 完成回调
Returns void

getAttrEditors

getAttrEditors(): AttributeEditorBase[]

- Defined in YH-Moble/src/wecom/WeComTools.ts:775
Returns AttributeEditorBase[]

getCheckinData

getCheckinData(openCheckinDataType: number, startTime: Date, endTime: Date, userIdList?: string[], callback?: WxCpCheckinHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1087
获取打卡数据注意:与函数 getCheckinDataEx 功能相识,差别是 startTime ,endTime 是时间类型

Parameters
- openCheckinDataType: number
  
  打卡类型。1：上下班打卡；2：外出打卡；3：全部打卡
- startTime: Date
  
  开始时间注意这个参数需要是时间类型
- endTime: Date
  
  结束时间注意这个参数需要是时间类型
- userIdList: string[] = ...
  
  需要获取打卡记录的用户列表注意这个每次最多能获取100个人的打卡数据如果需要更多请求分批获取
- Optional callback: WxCpCheckinHandle
  可选参数.完成回调函数
```
btn.getPage().components.WeComTools1.getCheckinData(3, new Date('2022-04-01'.replace(/-/g, '/')), new Date('2022-05-01'.replace(/-/g, '/')), ['clover'],
function (data, err) {
if (Common.isEmpty(err)) {
console.info(JSON.stringify(data));
} else {
console.info(err);
}
})
```
Returns void

getCheckinDataEx

getCheckinDataEx(openCheckinDataType: number, startTimeStr: string, endTimeStr: string, userIdList?: string[], callback?: WxCpCheckinHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1056
获取打卡数据. 注意:与函数 getCheckinData 功能相识,差别是 startTimeStr ,endTimeStr 是字符串类型

Parameters
- openCheckinDataType: number
  
  打卡类型。1：上下班打卡；2：外出打卡；3：全部打卡
- startTimeStr: string
  
  开始时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-04-01'
- endTimeStr: string
  
  结束时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-05-01'
- userIdList: string[] = ...
  
  需要获取打卡记录的用户列表注意这个每次最多能获取100个人的打卡数据如果需要更多请求分批获取
- Optional callback: WxCpCheckinHandle
  可选参数.完成回调函数
```
btn.getPage().components.WeComTools1.getCheckinDataEx(3, '2022-04-01', '2022-05-01', ['clover'],
function (data, err) {
if (Common.isEmpty(err)) {
console.info(JSON.stringify(data));
} else {
console.info(err);
}
})
```
Returns void

getCheckinDayData

getCheckinDayData(startTimeStr: string, endTimeStr: string, userIdList?: string[], callback?: WxOaHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1027
获取打卡日报数据

Parameters
- startTimeStr: string
  
  获取日报的开始时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-04-01'
- endTimeStr: string
  
  获取日报的结束时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-04-01'
- userIdList: string[] = ...
  
  获取日报的userid列表
- Optional callback: WxOaHandle
  
  可选参数. 完成回调
Returns void

日报数据列表 checkin day data

getCheckinMonthData

getCheckinMonthData(startTimeStr: string, endTimeStr: string, userIdList?: string[], callback?: WxOaHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1009
获取打卡月报数据 API doc: https://developer.work.weixin.qq.com/document/path/93387

Parameters
- startTimeStr: string
  
  获取月报的开始时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-04-01'
- endTimeStr: string
  
  获取月报的结束时间字符串. 格式:yyyy-MM-dd,yyyy/MM/dd 如: '2022-04-01'
- userIdList: string[] = ...
  
  获取月报的userid列表
- Optional callback: WxOaHandle
  
  可选参数. 完成回调
Returns void

月报数据列表

getCheckinOption

getCheckinOption(datetime: Date, callback?: WxApprovalDetailHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:976
获取打卡规则 API doc : https://work.weixin.qq.com/api/doc#90000/90135/90263

Parameters
- datetime: Date
  
  需要获取规则的当天日期需要获取规则的日期当天0点的Unix时间戳
- Optional callback: WxApprovalDetailHandle
  
  可选参数. 完成回调
Returns void

getDeparts

getDeparts(depid?: number, callback?: WxCpDepartsHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:902
获取部门官方API:https://work.weixin.qq.com/api/doc#90000/90135/90208

Parameters
- Optional depid: number
  
  可选参数. 部门id
- Optional callback: WxCpDepartsHandle
  完成回调
```
btn.getPage().components.WeComTools1.getDeparts(null, function (data, err) {
if (Common.isEmpty(err)) {
console.info(JSON.stringify(data));
} else {
console.info(err);
}
})
```
Returns void

getUserByDeptId

getUserByDeptId(depid: number, fetchChild?: boolean, status?: number, callback?: WxCpPersionInfoHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:928
获取人员信息官方API:https://work.weixin.qq.com/api/doc/90000/90135/90201

Parameters
- depid: number
  
  必填。部门id
- Optional fetchChild: boolean
  
  可选参数。1/0：是否递归获取子部门下面的成员默认值:0
- Optional status: number
  
  可选参数。0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加默认值:0
- Optional callback: WxCpPersionInfoHandle
  可选参数. 完成回调例子:
```
btn.getPage().components.WeComTools1.getUserByDeptId(1,true,0, function (data, err) {
if (Common.isEmpty(err)) {
console.info(JSON.stringify(data));
} else {
console.info(err);
}
})
```
Returns void

Private processResult

processResult(url: string, param: any, httptype: MethodType, callback: Function, async?: boolean): boolean

- Defined in YH-Moble/src/wecom/WeComTools.ts:815
统一请求

Parameters
- url: string
  
  地址
- param: any
  
  参数
- httptype: MethodType
  
  http类型
- callback: Function
  
  完成回调
- async: boolean = true
  
  异步
Returns boolean

refreshAccessToken

refreshAccessToken(callback?: WxCpAccessTokenHandle): string

- Defined in YH-Moble/src/wecom/WeComTools.ts:878
刷新企业微信的access_token 在access_token过期后调用

Parameters
- Optional callback: WxCpAccessTokenHandle
  
  完成回调
Returns string

返回accessToken字符串

render

render(parentcmp: any): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:795
Parameters
- parentcmp: any
Returns void

sendMessage

sendMessage(message: IWxCpMessage, callback?: WxMessageHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1098
发送消息

Parameters
- message: IWxCpMessage
  
  要发送的消息对象
- Optional callback: WxMessageHandle
  
  完成回调
Returns void

sendMessageToDept

sendMessageToDept(deptIds: string[], msgContent: string, callback?: WxMessageHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1127
发送消息给部门

Parameters
- deptIds: string[]
  
  指定接收消息部门ID列表，最多支持100个。
- msgContent: string
  
  消息内容
- Optional callback: WxMessageHandle
  
  完成回调
Returns void

sendMessageToTags

sendMessageToTags(tags: string[], msgContent: string, callback?: WxMessageHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1146
发送消息给标签. 也就是'@'消息给特定人群

Parameters
- tags: string[]
  
  指定接收消息的tag 人员ID列表，最多支持100个。
- msgContent: string
  
  消息内容
- Optional callback: WxMessageHandle
  
  完成回调
Returns void

sendMessageToUser

sendMessageToUser(userIds: string[], msgContent: string, callback?: WxMessageHandle): void

- Defined in YH-Moble/src/wecom/WeComTools.ts:1109
发送消息给用户

Parameters
- userIds: string[]
  
  指定接收消息的成员，成员ID列表（最多支持1000个）特殊情况：指定为"@all"，则向该企业应用的全部成员发送
- msgContent: string
  
  消息内容
- Optional callback: WxMessageHandle
  
  完成回调
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: any

Returns WeComTools

Properties

Private accessToken

agentId

orgId

Methods

ajax

Parameters

url: string

type: MethodType = ...

param: any = ...

async: boolean = true

Optional callback: WxCpAjaxHandle

Returns void

Private formatDate

Parameters

date: any

Returns string

getAccessToken

Parameters

Optional callback: WxCpAccessTokenHandle

Returns string

getApprovalDetail

Parameters

spNo: string

Optional callback: WxApprovalDetailHandle

Returns void

getApprovalNos

Parameters

startTime: string

endTime: string

cursor: number

size: number

filters: IWxCpApprovalInfoQueryFilter[] = ...

Optional callback: WxApprovalNosHandle

Returns void

getAttrEditors

Returns AttributeEditorBase[]

getCheckinData

Parameters

openCheckinDataType: number

startTime: Date

endTime: Date

userIdList: string[] = ...

Optional callback: WxCpCheckinHandle

Returns void

getCheckinDataEx

Parameters

openCheckinDataType: number

startTimeStr: string

endTimeStr: string

userIdList: string[] = ...

Optional callback: WxCpCheckinHandle

Returns void

getCheckinDayData

Parameters

startTimeStr: string

endTimeStr: string

userIdList: string[] = ...

Optional callback: WxOaHandle

Returns void

getCheckinMonthData

Parameters

startTimeStr: string

endTimeStr: string

userIdList: string[] = ...

Optional callback: WxOaHandle

Returns void

getCheckinOption

Parameters

datetime: Date