開発者向けONLYOFFICE Docs 7.5：APIとDoc Builderのアップデート

バージョン7.5の新機能リリースに伴い、エディタ、ドキュメントビルダー、プラグイン、デスクトップアプリのAPIを更新しました。詳細は以下をご覧ください。

フォームを扱うためのAPI

送信フォームボタンの表示/非表示。 editorConfig.customization.submitFormパラメータを使用して、OFORMファイルの送信ボタンを上部ツールバーに表示するか非表示にするかを定義することができます。

var docEditor = new DocsAPI.DocEditor("placeholder", {     
"editorConfig": {         
"customization": {
...
"submitForm": true,

強制保存のさらなるパラメータ。バージョン 7.5 では、コールバックハンドラの forcesavetype パラメータに 3 タイプを追加しました。これを適用すると、フォームが送信されるたびに、例えば「送信」ボタンがクリックされたときに、強制保存リクエストが実行されます。

{    
 "changesurl": "https://documentserver/url-to-changes.zip",     
"forcesavetype": 3,
....

文書を扱うためのAPI

外部データのソースの変更。新しく追加されたevents.onRequestReferenceSourceイベントは、ユーザがエディタで「ソースの変更」ボタンをクリックして外部データのソースを変更しようとしたときに呼び出されます。一意のファイルデータとファイルパスまたはファイル名を持つオブジェクトが data パラメータに送信されます。

ボタンがクリックされたら、外部データのソースを変更するために setReferenceSource メソッドを呼び出す必要があります。このメソッドを呼び出すときは、パラメータを検証するためにトークンを追加する必要があります。イベントが宣言されていない場合、「ソースの変更」ボタンは表示されません。

var onRequestReferenceSource = function () 
{     var referenceData =  event.data.referenceData;     
var path = event.data.path; 
...
    docEditor.setReferenceSource({        
"fileType": "xlsx",         
"path": "sample.xlsx",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},

キーフィールド。document.referenceDataパラメータに追加されるkeyフィールドは、サービスが共同編集セッションからデータを取得するために使用する一意のドキュメント識別子を定義します。

既知のキーが送信された場合、ドキュメントはキャッシュから取り出されます。ドキュメントが編集され保存されるたびに、キーは新たに生成されなければなりません。

ドキュメントのURLはキーとして使用できますが、特殊文字を含まず、長さは128シンボルに制限されています。

var docEditor = new DocsAPI.DocEditor("placeholder", {     
"document": {         
"fileType": "docx",         
"key": "Khirz6zTPdfd7",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},

変換API

変換APIは、コンバータが出力ファイル形式を自動的に決定できない場合に発生する-9エラーコードで拡張されています。

このエラーは、クライアントが変換するファイルの形式（テキスト文書またはスプレッドシート）を明示的に指定する必要があることを意味します。これは、XMLのタイプが不明な場合にXMLをOOXMLに変換するために使用されます。

{     
"error": -9 
}

その他の更新

• events.onRequestOpenイベントは、ソースを開くボタンを表示するために使用されます。
• 忘れられたファイルを操作するための deleteForgotten、getForgotten、および getForgottenList コマンド。
• 非推奨の events.onRequestMailMergeRecipients の代わりに events.onRequestSelectSpreadsheet イベント。
• 非推奨の setMailMergeRecipients の代わりに setRequestedSpreadsheet メソッド。
• 非推奨の events.onRequestCompareFile の代わりに events.onRequestSelectDocument イベント。
• 非推奨の setRevisedFile の代わりに setRequestedDocument メソッド。

さらに、デスクトップアプリAPIでは、デスクトップエディタをクラウドに接続する際のエディタテーマ設定を定義するuiThemeパラメータをportal:loginコマンドに追加しました。

ONLYOFFICE Docs Developer Editionの最新版を入手してください：

今すぐダウンロード

プラグイン用APIの強化

新しく追加されたShowButtonメソッドのalignパラメータは、ボタンがウィンドウの右側に表示されるか、左側に表示されるかを示します。デフォルト値は “left “です。

window.Asc.plugin.executeMethod ("ShowButton", ["back", false, "right"]);

ドキュメントビルダーのAPI更新

DocBuilder APIでは、複数の新しい透かし、コンボボックスとドロップダウンリストコンテンツコントロールメソッド、いくつかのグローバルメソッドとスライドメソッドを追加しました：

• ApiBlockLvlSdt/GetDropdownList
• ApiContentControlList/Add
• ApiDocument/GetWatermarkSettings
• ApiWatermarkSettings/GetDirection
• ApiSlide/GetVisible

新しいメソッドの全リストを確認してください。

ご注意: Document Builder v7.5のダウンロードはもう少し後になります。