開発者向けのONLYOFFICE ドキュメント 7.1：APIアップデート

2022年05月20日著者：Denis

新機能のリリースに伴い、エディタ、プラグイン、Document BuilderのAPIを更新しました。詳しくはこの記事をご覧ください。 ONLYOFFICE Docs 7.1 for developers: API updates

WOPI 操作の文書保存を調整する

新しいリクエストヘッダは、3種類のファイル保存を区別するためにPutFileで利用可能です。

X-LOOL-WOPI-IsModifiedByUser は、ユーザが保存前にドキュメントを修正したか、あるいは修正せずに「保存」ボタンだけを押したかを示す
X-LOOL-WOPI-IsAutosave は、PutFile が自動保存、または「保存」ボタンやメニュー項目を押すなどのユーザー操作によって起動されたかを示す
X-LOOL-WOPI-IsExitSave は、ドキュメントがメモリからクリーンアップされるとき、例えば、すべてのユーザーが切断されたとき、自動保存がトリガーされるかどうかを示す

変換機能の更新と新フォーマットの追加

PDF文書や画像として印刷するためのパラメータを指定する文書レイアウトを定義できるようになりました。さらに詳しく
PDF、XPS、OXPSからファイルを変換する際のドキュメントレンダラーを定義するパラメーターも追加されました。詳細はこちら
また、新しい変換オプションも追加されました。

PDFからDOCXへ
XPSとOXPSからDOCXへの変換
XLSBフォーマットからの変換（XLSBファイルを開くことができる）

情報表示のためのユーザーグループの定義

document.permissions.userInfoGroups パラメータを使用すると、エディタに情報を表示するユーザーのグループを以下のように指定することが可能です。

ヘッダーの現在編集中のユーザーのリストに表示されるユーザー名
テキスト入力時のユーザーカーソルおよびツールチップにユーザー名
厳密な共同編集モードでオブジェクトをロックする際のユーザー名

"permissions": {
  ...
  "userInfoGroups": ["Group1", ""]
  ...    },

ここで、 [“Group1”, “”] は、グループ1のユーザーとどのグループにも属していないユーザーの情報を表示することを意味します。

スペルチェッカー設定

バージョン7.1より、editorConfig.customization.features パラメータセクションを追加し、スペルチェッカーを含む、ユーザーが可能な限り無効化またはカスタマイズできるパラメータを設定できるようにしました。editorConfig.customization.spellcheckフィールドは廃止され、代わりにeditorConfig.customization.features.spellcheckフィールドを使用して、ドキュメントまたはプレゼンテーションエディタのロード時にスペルチェッカーを自動的にオンにするかオフにするかを定義する必要があります。

"features": {
  "spellcheck": {
  "mode": true,
  }

その他の変更点

初期化設定シグネチャのパラメータリストが厳格に規定されるようになりました。
editorConfig.customization.chatパラメータは非推奨です。代わりにdocument.permissions.chatパラメータを使用してください。
services.CoAuthoring.token.inbox.inBodyとservices.CoAuthoring.token.outbox.inBodyパラメータは、トークンをボディで有効にするために非推奨となりました。

開発者向けのONLYOFFICE ドキュメントの最新版を入手しましょう。

今すぐインストール

プラグイン用APIの更新

プラグインのコマンドコードやマクロから、ウィンドウ、ドキュメントオブジェクト、アラート機能へのアクセスを制限しました。詳細はこちら
OLEオブジェクトを使用するプラグイン用の新しいメソッドです。GetAllOleObjects、RemoveOleObject、RemoveOleObjects、および SelectOleObject。

プラグインの作成方法について

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

DocBuilderのAPIが大幅に強化されました。DOCX, XLSX, PPTX, PDF ファイルの生成に加え、例えば、記入式フォームを扱うことができるようになりました。

builder.CreateFile("docxf");
ONLYOFFICE Document Builder
var oDocument = Api.GetDocument();  
text document contents
var oTextForm = Api.CreateTextForm();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm); 
oTextForm.SetText("John Smith"); 
builder.SaveFile("docxf", "example.docxf");
format with the 'example.docxf' name
builder.CloseFile();   
ONLYOFFICE Document Builder