onlyoffice连接器(connector)开发使用精讲 二次开发 深入开发【一】

本文主要是介绍onlyoffice连接器(connector)开发使用精讲 二次开发 深入开发【一】,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

        连接器是onlyoffice调用web api的一个基础工具,可以方便开发者或者用户与业务系统结合使用web功能。

        关于connector官方说明文档在这里:Automation API - ONLYOFFICE Api Documentation

        注意:该功能针对开发者版、企业版,社区版常规不支持此功能。因此这里为了方便交流学习,给开发者提供一个演示环境。如果你有疑问或者其他需求,可以联系我,具体我会放到最后。

http://47.94.91.67:10100/web-apps/apps/api/documents/api.js

一、关于连接器(connector)的初步介绍

        对于绝大部分开发者而言,很多情况下都是简单的操作一下文档,做一些和业务系统相关操作的功能,使用到:callCommand 、executeMethod、attachEvent、detachEvent这四个核心快api模块。我本人用的比较深入,也基本只用到上面4个,本教程范围也就是上面四个核心快。

二、核心快初步说明

        1、callCommand()。基础api调用模块,用于组合并执行复杂api或者自定义代码,100%的情况你都需要使用。文档在这:Overview - ONLYOFFICE Api DocumentationONLYOFFICE Developer APIicon-default.png?t=N7T8https://api.onlyoffice.com/officeapi/basic

        2、executeMethod()。直接执行某个api,它与callCommand的区别是:callCommand是自己写代码执行也就是执行function(){xxxxx}方法体,executeMethod执行的只是某一个方法。后面的Demo中将会有更直观的展示,一看就懂。文档在这:executeMethod - ONLYOFFICE Api DocumentationONLYOFFICE Developer APIicon-default.png?t=N7T8https://api.onlyoffice.com/plugin/executemethod

        3、attachEvent、detachEvent也就是绑定、解绑事件,这个比较常规。文档在这:Events - ONLYOFFICE Api DocumentationONLYOFFICE Developer APIicon-default.png?t=N7T8https://api.onlyoffice.com/plugin/events

三、示例与详解

/**
* 全局初始化连接器
*/
var connector = docEditor.createConnector()

callCommand介绍

        callCommand执行的是自定义的方法体,比如:增加批注,先查找文档AddComment - ONLYOFFICE Api Documentation,然后参照使用红框部分即可【图1】:

// Asc.scope为入参,需要传入方法体的对象
Asc.scope.text = "Hello world!"; connector.callCommand(function() {var oDocument = Api.GetDocument();var oParagraph = oDocument.GetElement(0);oParagraph.AddText(Asc.scope.text);Api.AddComment(oParagraph, "ONLYOFFICE for developers", "Jane", "uid-1");}, function() { console.log("执行完成回调"); });

图1

callCommand结束,更多的api开发者可以自行查看,使用方法都是一样的:AddComment - ONLYOFFICE Api Documentation

executeMethod介绍

        executeMethod是直接执行某个方法,可以执行的方法在这:executeMethod - ONLYOFFICE Api Documentation

connector.executeMethod ("AddComment", [{"UserName": "John Smith","QuoteText": "text","Text": "comment","Time": "1662737941471","Solved": true,"Replies": [{"UserName": "Mark Potato","Text": "reply 1","Time": "1662740895892","Solved": false}]}
], function (comment) {console.log (comment)
});

        参数解释,AddComment【方法名】,[arg1, arg2, arg3..........]该方法使用的数使用输入传入,回调方法。实际调用为:

function AddComment(paramObj){return comment;
}var comment = AddComment({"UserName": "John Smith","QuoteText": "text","Text": "comment","Time": "1662737941471","Solved": true,"Replies": [{"UserName": "Mark Potato","Text": "reply 1","Time": "1662740895892","Solved": false}]});

executeMethod结束

        

attachEvent、detachEvent介绍

        attachEvent、detachEvent就是常规的前端事件绑定,关于这一块就比较简单理解了,只能用Demo展示一下,这里不深入讲解。具体的需要开发者自行使用。可以绑定的事件在这:Events - ONLYOFFICE Api Documentation

/**
* 绑定事件
*/
connector.attachEvent("onAddComment", function(){console.log("event: onAddComment");
});/**
* 解绑事件
*/
connector.detachEvent("onAddComment");

attachEvent、detachEvent结束

四、总结

        callCommand是100%情况都需要使用到的。attachEvent、detachEvent部分情况会使用。executeMethod因为只执行单个方法,用的地方就少一些,大部分都是用callCommand代替。

        连接器简单使用就是上面这些,但是实际用法比这个深入得多,后续会开【第二期讲解】。

五、交流与联系

        我本人主要研究实现的api和源码,用以开发自己的独立版本系统,实现更多的实用功能,如果你需要独立部署也可以V我,也希望和大家多多交流:【cao_rui_jian_xiong】

这篇关于onlyoffice连接器(connector)开发使用精讲 二次开发 深入开发【一】的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1095741

相关文章

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数?getopt模块基础实际应用示例与其他参数处理方式的比较常见问http

C 语言中enum枚举的定义和使用小结

《C语言中enum枚举的定义和使用小结》在C语言里,enum(枚举)是一种用户自定义的数据类型,它能够让你创建一组具名的整数常量,下面我会从定义、使用、特性等方面详细介绍enum,感兴趣的朋友一起看... 目录1、引言2、基本定义3、定义枚举变量4、自定义枚举常量的值5、枚举与switch语句结合使用6、枚

使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)

《使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)》PPT是一种高效的信息展示工具,广泛应用于教育、商务和设计等多个领域,PPT文档中常常包含丰富的图片内容,这些图片不仅提升了... 目录一、引言二、环境与工具三、python 提取PPT背景图片3.1 提取幻灯片背景图片3.2 提取

使用Python实现图像LBP特征提取的操作方法

《使用Python实现图像LBP特征提取的操作方法》LBP特征叫做局部二值模式,常用于纹理特征提取,并在纹理分类中具有较强的区分能力,本文给大家介绍了如何使用Python实现图像LBP特征提取的操作方... 目录一、LBP特征介绍二、LBP特征描述三、一些改进版本的LBP1.圆形LBP算子2.旋转不变的LB

Maven的使用和配置国内源的保姆级教程

《Maven的使用和配置国内源的保姆级教程》Maven是⼀个项目管理工具,基于POM(ProjectObjectModel,项目对象模型)的概念,Maven可以通过一小段描述信息来管理项目的构建,报告... 目录1. 什么是Maven?2.创建⼀个Maven项目3.Maven 核心功能4.使用Maven H

Python中__init__方法使用的深度解析

《Python中__init__方法使用的深度解析》在Python的面向对象编程(OOP)体系中,__init__方法如同建造房屋时的奠基仪式——它定义了对象诞生时的初始状态,下面我们就来深入了解下_... 目录一、__init__的基因图谱二、初始化过程的魔法时刻继承链中的初始化顺序self参数的奥秘默认

SpringBoot使用GZIP压缩反回数据问题

《SpringBoot使用GZIP压缩反回数据问题》:本文主要介绍SpringBoot使用GZIP压缩反回数据问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录SpringBoot使用GZIP压缩反回数据1、初识gzip2、gzip是什么,可以干什么?3、Spr

Spring Boot 集成 Quartz并使用Cron 表达式实现定时任务

《SpringBoot集成Quartz并使用Cron表达式实现定时任务》本篇文章介绍了如何在SpringBoot中集成Quartz进行定时任务调度,并通过Cron表达式控制任务... 目录前言1. 添加 Quartz 依赖2. 创建 Quartz 任务3. 配置 Quartz 任务调度4. 启动 Sprin

Linux下如何使用C++获取硬件信息

《Linux下如何使用C++获取硬件信息》这篇文章主要为大家详细介绍了如何使用C++实现获取CPU,主板,磁盘,BIOS信息等硬件信息,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录方法获取CPU信息:读取"/proc/cpuinfo"文件获取磁盘信息:读取"/proc/diskstats"文

Java使用SLF4J记录不同级别日志的示例详解

《Java使用SLF4J记录不同级别日志的示例详解》SLF4J是一个简单的日志门面,它允许在运行时选择不同的日志实现,这篇文章主要为大家详细介绍了如何使用SLF4J记录不同级别日志,感兴趣的可以了解下... 目录一、SLF4J简介二、添加依赖三、配置Logback四、记录不同级别的日志五、总结一、SLF4J