Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
dingtalk-sdk
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
open-source
dingtalk-sdk
Commits
4519e468
Commit
4519e468
authored
Sep 06, 2020
by
Francis Zhou
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
update method args documention
parent
f1d62302
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
10 additions
and
10 deletions
+10
-10
corp_conversation.rb
lib/dingtalk_sdk/corp_conversation.rb
+4
-4
department.rb
lib/dingtalk_sdk/department.rb
+2
-2
storage.rb
lib/dingtalk_sdk/storage.rb
+1
-1
user.rb
lib/dingtalk_sdk/user.rb
+3
-3
No files found.
lib/dingtalk_sdk/corp_conversation.rb
View file @
4519e468
...
@@ -9,7 +9,7 @@ module DingtalkSdk
...
@@ -9,7 +9,7 @@ module DingtalkSdk
# 发送工作通知消息
# 发送工作通知消息
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy}
# @!method send_corp_conversation(userid_list:, dept_id_list:, to_all_user:, msg:
, access_token:
)
# @!method send_corp_conversation(userid_list:, dept_id_list:, to_all_user:, msg:)
# @return [Hash]
# @return [Hash]
add_request
:send_corp_conversation
,
:post
,
DingtalkSdk
::
RequestUrl
::
SEND_CORP_CONVERSATION
do
|
request
|
add_request
:send_corp_conversation
,
:post
,
DingtalkSdk
::
RequestUrl
::
SEND_CORP_CONVERSATION
do
|
request
|
request
.
add_arg
:userid_list
,
in: :body
request
.
add_arg
:userid_list
,
in: :body
...
@@ -24,7 +24,7 @@ module DingtalkSdk
...
@@ -24,7 +24,7 @@ module DingtalkSdk
# 查询工作通知消息的发送进度
# 查询工作通知消息的发送进度
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy/e2262dad}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy/e2262dad}
# @!method get_corp_conversation_progress(task_id:
, access_token:
)
# @!method get_corp_conversation_progress(task_id:)
# @return [Hash]
# @return [Hash]
add_request
:get_corp_conversation_progress
,
:post
,
DingtalkSdk
::
RequestUrl
::
CORP_CONVERSATION_SEND_PROGRESS
do
|
request
|
add_request
:get_corp_conversation_progress
,
:post
,
DingtalkSdk
::
RequestUrl
::
CORP_CONVERSATION_SEND_PROGRESS
do
|
request
|
request
.
add_arg
:task_id
,
in: :body
,
required:
true
request
.
add_arg
:task_id
,
in: :body
,
required:
true
...
@@ -35,7 +35,7 @@ module DingtalkSdk
...
@@ -35,7 +35,7 @@ module DingtalkSdk
# 查询工作通知消息的发送结果
# 查询工作通知消息的发送结果
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy/a5920210}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy/a5920210}
# @!method get_corp_conversation_result(task_id:
, access_token:
)
# @!method get_corp_conversation_result(task_id:)
# @return [Hash]
# @return [Hash]
add_request
:get_corp_conversation_result
,
:post
,
DingtalkSdk
::
RequestUrl
::
CORP_CONVERSATION_SEND_RESULT
do
|
request
|
add_request
:get_corp_conversation_result
,
:post
,
DingtalkSdk
::
RequestUrl
::
CORP_CONVERSATION_SEND_RESULT
do
|
request
|
request
.
add_arg
:task_id
,
in: :body
,
required:
true
request
.
add_arg
:task_id
,
in: :body
,
required:
true
...
@@ -46,7 +46,7 @@ module DingtalkSdk
...
@@ -46,7 +46,7 @@ module DingtalkSdk
# 工作通知消息撤回
# 工作通知消息撤回
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy/hYyV8}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/pgoxpy/hYyV8}
# @!method recall_corp_conversation(msg_task_id:
, access_token:
)
# @!method recall_corp_conversation(msg_task_id:)
# @return [Hash]
# @return [Hash]
add_request
:recall_corp_conversation
,
:post
,
DingtalkSdk
::
RequestUrl
::
RECALL_CORP_CONVERSATION
do
|
request
|
add_request
:recall_corp_conversation
,
:post
,
DingtalkSdk
::
RequestUrl
::
RECALL_CORP_CONVERSATION
do
|
request
|
request
.
add_arg
:msg_task_id
,
in: :body
,
required:
true
request
.
add_arg
:msg_task_id
,
in: :body
,
required:
true
...
...
lib/dingtalk_sdk/department.rb
View file @
4519e468
...
@@ -9,7 +9,7 @@ module DingtalkSdk
...
@@ -9,7 +9,7 @@ module DingtalkSdk
# 获取部门列表
# 获取部门列表
# {https://ding-doc.dingtalk.com/doc#/serverapi2/dubakq/e6e1604e}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/dubakq/e6e1604e}
# @!method get_department_list(id:, fetch_child:
, access_token:
)
# @!method get_department_list(id:, fetch_child:)
# @return [Hash]
# @return [Hash]
add_request
:get_department_list
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_DEPARTMENT_LIST
do
|
request
|
add_request
:get_department_list
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_DEPARTMENT_LIST
do
|
request
|
request
.
add_arg
:id
,
in: :query
# 父部门id(如果不传,默认部门为根部门,根部门ID为1)
request
.
add_arg
:id
,
in: :query
# 父部门id(如果不传,默认部门为根部门,根部门ID为1)
...
@@ -19,7 +19,7 @@ module DingtalkSdk
...
@@ -19,7 +19,7 @@ module DingtalkSdk
# 获取部门详情
# 获取部门详情
# {https://ding-doc.dingtalk.com/doc#/serverapi2/dubakq/5bf960de}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/dubakq/5bf960de}
# @!method get_department_profile(id:
, access_token:
)
# @!method get_department_profile(id:)
# @return [Hash]
# @return [Hash]
add_request
:get_department_profile
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_DEPARTMENT_PROFILE
do
|
request
|
add_request
:get_department_profile
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_DEPARTMENT_PROFILE
do
|
request
|
request
.
add_arg
:id
,
in: :query
,
required:
true
request
.
add_arg
:id
,
in: :query
,
required:
true
...
...
lib/dingtalk_sdk/storage.rb
View file @
4519e468
...
@@ -9,7 +9,7 @@ module DingtalkSdk
...
@@ -9,7 +9,7 @@ module DingtalkSdk
# 上传媒体文件
# 上传媒体文件
# {https://ding-doc.dingtalk.com/doc#/serverapi2/bcmg0i/08d5a73b}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/bcmg0i/08d5a73b}
# @!method upload_media(type:,
access_token:,
media:)
# @!method upload_media(type:, media:)
# @return [Hash]
# @return [Hash]
add_request
:upload_media
,
:post
,
DingtalkSdk
::
RequestUrl
::
UPLOAD_MEDIA_FILE
do
|
request
|
add_request
:upload_media
,
:post
,
DingtalkSdk
::
RequestUrl
::
UPLOAD_MEDIA_FILE
do
|
request
|
request
.
add_arg
:type
,
in:
query
,
required:
true
request
.
add_arg
:type
,
in:
query
,
required:
true
...
...
lib/dingtalk_sdk/user.rb
View file @
4519e468
...
@@ -9,7 +9,7 @@ module DingtalkSdk
...
@@ -9,7 +9,7 @@ module DingtalkSdk
# 获取用户详情
# 获取用户详情
# {https://ding-doc.dingtalk.com/doc#/serverapi2/ege851/AaRQe}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/ege851/AaRQe}
# @!method get_user_profile(userid:
, access_token:
)
# @!method get_user_profile(userid:)
# @return [Hash]
# @return [Hash]
add_request
:get_user_profile
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_USER_PROFILE
do
|
request
|
add_request
:get_user_profile
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_USER_PROFILE
do
|
request
|
request
.
add_arg
:userid
,
required:
true
,
in: :query
request
.
add_arg
:userid
,
required:
true
,
in: :query
...
@@ -18,7 +18,7 @@ module DingtalkSdk
...
@@ -18,7 +18,7 @@ module DingtalkSdk
# 根据 unionId 获取 userId
# 根据 unionId 获取 userId
# {https://ding-doc.dingtalk.com/doc#/serverapi2/ege851/602f4b15}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/ege851/602f4b15}
# @!method get_userid_by_unionid(unionid:
, access_token:
)
# @!method get_userid_by_unionid(unionid:)
# @return [Hash]
# @return [Hash]
add_request
:get_userid_by_unionid
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_USERID_FROM_UNIONID
do
|
request
|
add_request
:get_userid_by_unionid
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_USERID_FROM_UNIONID
do
|
request
|
request
.
add_arg
:unionid
,
required:
true
,
in: :query
request
.
add_arg
:unionid
,
required:
true
,
in: :query
...
@@ -27,7 +27,7 @@ module DingtalkSdk
...
@@ -27,7 +27,7 @@ module DingtalkSdk
# 根据手机号获取 userId
# 根据手机号获取 userId
# {https://ding-doc.dingtalk.com/doc#/serverapi2/ege851/soV11}
# {https://ding-doc.dingtalk.com/doc#/serverapi2/ege851/soV11}
# @!method get_userid_by_mobile(mobile:
, access_token:
)
# @!method get_userid_by_mobile(mobile:)
# @return [Hash]
# @return [Hash]
add_request
:get_userid_by_mobile
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_USERID_FROM_MOBILE
do
|
request
|
add_request
:get_userid_by_mobile
,
:get
,
DingtalkSdk
::
RequestUrl
::
GET_USERID_FROM_MOBILE
do
|
request
|
request
.
add_arg
:mobile
,
required:
true
,
in: :query
request
.
add_arg
:mobile
,
required:
true
,
in: :query
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment