PC用及移动端用API一览表

aki发表于:2016年12月19日 16:20:28更新于:2021年08月24日 10:01:59

PC用及移动端用API一览表

仅可在PC页面上使用的API、仅可在移动端上使用的API以及两者都可使用的API总结如下表。
详情请参考相应的各链接。

※移动端API适用于以下环境。

表格内符合与用语说明

  • ×:不支持API

  • 无此功能:无执行API所需的功能

事件

 APIPC移动端

记录列表页面显示后的事件
(app.record.index.show )

○ 

○ ※1

记录列表页面的行内编辑保存前的事件
(app.record.index.edit.submit)

○  

无此功能

记录列表页面的行内编辑保存成功后的事件
(app.record.index.edit.submit.success)

无此功能

记录列表页面的行内编辑开始时的事件
(app.record.index.edit.show)

○ 

无此功能

在记录列表页面更改记录值时的事件
(app.record.index.edit.change.<字段代码>)

○  

无此功能

在记录列表页面执行记录删除前的事件
(app.record.index.delete.submit)

无此功能

记录添加页面显示后的事件
(app.record.create.show)

○  

○ ※1

记录添加页面在执行保存之前的事件
(app.record.create.submit)

○  

○ ※1

记录添加页面保存成功后的事件
(app.record.create.submit.success)

○ ※1

记录添加页面的字段值发生更改时的事件
(app.record.create.change.<字段代码>)

○  

○ ※1

记录详情页面显示后的事件
(app.record.detail.show)

○  

○ ※1

记录详情页面在执行删除之前的事件
(app.record.detail.delete.submit)

○ ※1

流程管理的动作执行事件
(app.record.detail.process.proceed)

○ ※1

记录编辑页面显示后的事件
(app.record.edit.show)

○  

○ ※1

记录编辑页面在执行保存之前的事件
(app.record.edit.submit)

○  

○ ※1

记录编辑页面保存成功后的事件
(app.record.edit.submit.success)

○ ※1

在记录编辑页面更改字段值时的事件
(app.record.edit.change.<字段代码>)

○ ※1

记录打印页面显示后的事件

(app.record.print.show)

无此功能

图表显示后的事件

(app.report.show)

○ ※1

门户显示后事件

(portal.show)

○ ※1

※1…所有移动端专用的函数都要在PC专用的函数的前面加上“mobile”。

例:PC 专用 ⇒ app.record.index.show 移动端专用 ⇒ mobile.app.record.index.show

信息的获取与设置

 API PC移动端

执行kintone REST API

(kintone.api) 

获取记录的值

(kintone.app.record.get)

○  

○ ※2

给记录设置值

(kintone.app.record.set)

○ 

○ ※2

获取应用ID

(kintone.app.getId)

○  

○ ※2

获取列表的查询字符串

(kintone.app.getQueryCondition)

○  

○ ※2

获取列表的查询字符串(带选项)

(kintone.app.getQuery)

○  

○ ※2

获取记录ID

(kintone.app.record.getId)

○  ○ ※2

获取登录用户的信息

(kintone.getLoginUser)

○  

获取设计版本

(kintone.getUiVersion)

获取kintone REST API 的并发连接数

(kintone.api.getConcurrencyLimit)

在URL的查询部分指定要显示的记录的条件

无此功能

获取关联记录列表所关联的应用ID

(kintone.app.getRelatedRecordsTargetAppId)

○  ○ ※2

获取lookup所参照的应用ID

(kintone.app.getLookupTargetAppId)

○  ○ ※2

获取URL(无查询字符串)

(kintone.api.url)

获取URL(带查询字符串)

(kintone.api.urlForGet)

获取CSRF令牌

(kintone.getRequestToken)

执行外部API

(kintone.proxy)

文件下载到外部

(kintone.proxy.upload)

字段的显示/隐藏
(kintone.app.record.setFieldShown)

○ ※2

组合字段的开闭
(kintone.app.record.setGroupFieldOpen)

○ ※2

※ 2…所有移动端专用的函数都要在kintone的后面加上“mobile”。

例:PC 专用 ⇒ kintone.app.record.get 移动端专用 ⇒ kintone.mobile.app.record.get

获取元素

 API PC移动端

获取页面顶部下方的空白部分的元素(记录详情页面记录列表页面

(kintone.mobile.app.getHeaderSpaceElement)

无此功能

获取列表的字段元素

(kintone.app.getFieldElements)

○ ※2

获取列表页面菜单栏右侧的空白部分的元素

(kintone.app.getHeaderMenuSpaceElement) 

○ 

×

获取列表页面菜单栏下方的空白部分的元素

(kintone.app.getHeaderSpaceElement)

×

获取详细页面的字段元素

(kintone.app.record.getFieldElement)

○ ※2

获取详细页面的菜单栏右边的空白部分的元素

(kintone.app.record.getHeaderMenuSpaceElement)

○  

× 

获取空白栏字段的元素

(kintone.app.record.getSpaceElement)

○ ※2

获取门户上方的空白部分的元素

(kintone.portal.getContentSpaceElement)

○ ※2

※2…所有移动端专用的函数都要在PC专用的函数的前面加上“mobile”。

例:PC 专用 ⇒ kintone.app.record.get 移动端专用 ⇒ kintone.mobile.app.record.get

回复(8)

  • cybozu

    不好意思,一些和这个主题无关的问题请去社区提问,谢谢。

    引用 追梦人 的回复:

    file 组件 上传 文件以后 如何 通过代码 把 file 组件 上传的文件 清空,可以做到吗

  • 追梦人

    file 组件 上传 文件以后 如何 通过代码 把 file 组件 上传的文件 清空,可以做到吗


    引用 betsy_yan 的回复:

    “记录编辑页面在执行保存之前的事件(app.record.edit.submit)”这个事件可以检测是否上传过

  • betsy_yan

    “记录编辑页面在执行保存之前的事件(app.record.edit.submit)”这个事件可以检测是否上传过

    引用 追梦人 的回复:

    用代码可以检测 附件   是否有上传过吗?

  • 追梦人

    用代码可以检测 附件   是否有上传过吗?

    引用 cybozu 的回复:

    你可以将附件设置为必填项。或者在“记录编辑页面在执行保存之前的事件(app.record.edit.submit)”这个事件上判断附件字段的值

  • cybozu

    你可以将附件设置为必填项。或者在“记录编辑页面在执行保存之前的事件(app.record.edit.submit)”这个事件上判断附件字段的值

    引用 追梦人 的回复:

    您好,我的应用中有一个上传 附件 的组件,保存的时候如何验证是否上传过了,如果没有上传提示:必须上传。我改如何来设置呢?

  • 追梦人

    您好,我的应用中有一个上传 附件 的组件,保存的时候如何验证是否上传过了,如果没有上传提示:必须上传。我改如何来设置呢?

  • cybozu

    官网就有下载

    https://www.cybozu.cn/support/kintone.html

    引用 closer 的回复:

    请问,智能手机的应用程序哪里可以下载呢 

  • closer

    请问,智能手机的应用程序哪里可以下载呢