Developer Edition ONLYOFFICE ドキュメント 7.5: API およびドキュメントジェネレーターの更新

バージョン 7.5 の新機能のリリースに伴い、ONLYOFFICE はエディター、ドキュメントジェネレーター、プラグイン、デスクトップアプリケーションの API を更新しました。詳細については、この記事を読んでください。

開発者向け ONLYOFFICE Docs 7.5: API および Doc Builder の更新

フォームを処理するための API

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

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

強制保存のパラメータの追加:バージョン 7.5 では、ONLYOFFICE はコールバックハンドラの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パラメーターに追加されたキーフィールドは、サービスが共同編集セッションからデータを取得するために使用する一意のドキュメント ID を定義します。

既知のキーを送信する場合、ドキュメントはキャッシュからフェッチされます。キーは、ドキュメントを編集して保存するたびに再生成する必要があります。

ドキュメント 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では、ONLYOFFICE がportal:login コマンドにuiThemeパラメーターを追加しました。これは、デスクトップエディターをクラウドに接続するときのエディターのテーマ設定を定義します。

プラグイン API の最適化

ShowButtonメソッドの新しく追加された align パラメータは、デフォルト値は「左」です。

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

ドキュメントジェネレーター API の更新

ドキュメントビルダー API で、ONLYOFFICE は、次のメソッドを含む、複数の新しいウォーターマーク、コンボボックス、ドロップダウンリストのコンテンツコントロールメソッド、複数のグローバルメソッドとスライドショーメソッドを追加します。

新しいメソッドの完全なリストを参照してください。

注: Documentation Builder v7.5 は後日ダウンロードできるようになります。