Skip to content

Commit

Permalink
Merge pull request #248 from ONLYOFFICE/develop
Browse files Browse the repository at this point in the history
Release/2.6.0
  • Loading branch information
LinneyS authored Feb 7, 2022
2 parents 6bf5efc + 86353ca commit e4c19f9
Show file tree
Hide file tree
Showing 43 changed files with 179 additions and 228 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log

## 2.6.0
- plugins: added the "version" parameter to config
- desktop: v7.0
- desktop: added the extraLogout parameter to config

## 2.5.0
- editors: test examples v1.1.0
- editors: docxf and oform on try page
Expand Down
16 changes: 15 additions & 1 deletion web/App_Data/products.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@
{
"Item1":"PostMessage",
"Item2":"wopi/postmessage"
},
{
"Item1":"API vs WOPI",
"Item2":"wopi/apivswopi"
}
],
"Additional API":[
Expand Down Expand Up @@ -220,19 +224,29 @@
"Item1":"List of classes",
"Item2":"classlist"
}
],
"More information":[
{
"Item1":"Changelog",
"Item2":"changelog"
}
]
}
},
{
"id":"desktop",
"title":"Desktop Editors",
"description":"Extend the ONLYOFFICE Desktop Editors functionality. In this section you will learn how to set up, customize and integrate them with the document management systems.",
"version":"6.4",
"version":"7.0",
"links":{
"Get Started":[
{
"Item1":"Overview",
"Item2":"basic"
},
{
"Item1":"How it works",
"Item2":"howitworks"
}
],
"Usage API":[
Expand Down
Binary file modified web/Content/img/Editor/customization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 14 additions & 7 deletions web/Views/Desktop/AddingDMS/Default.ascx
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,18 @@
<td>object</td>
<td></td>
</tr>
<tr class="tablerow">
<td id="entryPage" class="copy-link">entryPage</td>
<td>Defines the URL to connect the provider. It is used instead of the provider address and allows the desktop app not to send the <a href="#check">check</a> request.</td>
<td>string</td>
<td>"https://url-to-connect-provider.com"</td>
</tr>
<tr class="tablerow">
<td id="extraLogout" class="copy-link">extraLogout</td>
<td>Defines the URL to log out from the cloud. It is used instead of the provider address.</td>
<td>string or array of strings</td>
<td>"https://url-for-logout.com"</td>
</tr>
<tr>
<td id="editorPage" class="copy-link">editorPage</td>
<td>
Expand All @@ -95,12 +107,6 @@
<div class="note">You can use regular expressions for this parameter. For example, <em>"regex:\/lib\/(?:[\w-]{32,})\/file\/"</em>.</div>
</td>
</tr>
<tr class="tablerow">
<td id="entryPage" class="copy-link">entryPage</td>
<td>Defines the URL to connect the provider. It is used instead of the provider address and allows the desktop app not to send the <a href="#check">check</a> request.</td>
<td>string</td>
<td>"https://url-to-connect-provider.com"</td>
</tr>
<tr class="tablerow">
<td id="startPage" class="copy-link">startPage</td>
<td>Defines the relative URL added to the entered IP or domain when creating a new connection.</td>
Expand Down Expand Up @@ -143,8 +149,9 @@
"OCS-APIREQUEST": true
}
},
"editorPage" : "/apps/onlyoffice/",
"entryPage" : "https://url-to-connect-provider.com",
"extraLogout" : "https://url-for-logout.com",
"editorPage" : "/apps/onlyoffice/",
"startPage" : "/",
"icons" : {
"themeLight": {
Expand Down
225 changes: 111 additions & 114 deletions web/Views/Desktop/AddingDMS/LoginLogout.ascx
Original file line number Diff line number Diff line change
Expand Up @@ -44,86 +44,84 @@ AscDesktopEditor.execCommand (command, parameters)
</table>
<div class="mobile-content"></div>

<ol>
<li id="login" class="copy-link">
<p><b>portal:login</b></p>
<p>When the <em>portal:login</em> command is sent, the cloud is registered and listed on the <b>Connected clouds</b> page.
Call the command on all the pages you can access after logging in to your cloud.
Parameters are specified in the format of a string with the serialized <em>json</em> as follows:</p>
<pre>
<h2 id="login" class="copy-link">portal:login</h2>
<p>When the <em>portal:login</em> command is sent, the cloud is registered and listed on the <b>Connected clouds</b> page.
Call the command on all the pages you can access after logging in to your cloud.
Parameters are specified in the format of a string with the serialized <em>json</em> as follows:</p>
<pre>
{
"displayName": "user name",
"email": "[email protected]",
"domain": "domain name",
"provider": "provider",
"userId": "user id"
"displayName": "user name",
"email": "[email protected]",
"domain": "domain name",
"provider": "provider",
"userId": "user id"
}
</pre>

<div class="header-gray">Parameters</div>
<table class="table">
<colgroup>
<col class="table-name" />
<col />
<col class="table-type" />
<col class="table-example" />
</colgroup>
<thead>
<tr class="tablerow">
<td>Name</td>
<td>Description</td>
<td>Type</td>
<td>Example</td>
</tr>
</thead>
<tbody>
<tr class="tablerow">
<td id="displayName" class="copy-link">displayName<span class="required">*</span></td>
<td>
Defines the user name displayed on the <b>Connected clouds</b> page.
</td>
<td>string</td>
<td>"John Smith"</td>
</tr>
<tr class="tablerow">
<td id="email" class="copy-link">email</td>
<td>
Defines the user email displayed on the <b>Connected clouds</b> page.
</td>
<td>string</td>
<td>"[email protected]"</td>
</tr>
<tr class="tablerow">
<td id="domain" class="copy-link">domain<span class="required">*</span></td>
<td>
Defines the cloud name and the cloud entry point.
</td>
<td>string</td>
<td>"https://exampledomain.com"</td>
</tr>
<tr class="tablerow">
<td id="provider" class="copy-link">provider<span class="required">*</span></td>
<td>
Defines the provider id used to refer to the desktop app in the JavaScript commands (the same as in the <a href="<%= Url.Action("addingdms/") %>">config</a>).
</td>
<td>string</td>
<td>"onlyoffice"</td>
</tr>
<tr class="tablerow">
<td id="userId" class="copy-link">userId<span class="required">*</span></td>
<td>
Defines the user id.
</td>
<td>string</td>
<td>"78e1e841"</td>
</tr>
</tbody>
</table>
<div class="mobile-content"></div>
<span class="required-descr"><span class="required">*</span><em> - required field</em></span>
<div class="header-gray">Parameters</div>
<table class="table">
<colgroup>
<col class="table-name" />
<col />
<col class="table-type" />
<col class="table-example" />
</colgroup>
<thead>
<tr class="tablerow">
<td>Name</td>
<td>Description</td>
<td>Type</td>
<td>Example</td>
</tr>
</thead>
<tbody>
<tr class="tablerow">
<td id="displayName" class="copy-link">displayName<span class="required">*</span></td>
<td>
Defines the user name displayed on the <b>Connected clouds</b> page.
</td>
<td>string</td>
<td>"John Smith"</td>
</tr>
<tr class="tablerow">
<td id="email" class="copy-link">email</td>
<td>
Defines the user email displayed on the <b>Connected clouds</b> page.
</td>
<td>string</td>
<td>"[email protected]"</td>
</tr>
<tr class="tablerow">
<td id="domain" class="copy-link">domain<span class="required">*</span></td>
<td>
Defines the cloud name and the cloud entry point.
</td>
<td>string</td>
<td>"https://exampledomain.com"</td>
</tr>
<tr class="tablerow">
<td id="provider" class="copy-link">provider<span class="required">*</span></td>
<td>
Defines the provider id used to refer to the desktop app in the JavaScript commands (the same as in the <a href="<%= Url.Action("addingdms/") %>">config</a>).
</td>
<td>string</td>
<td>"onlyoffice"</td>
</tr>
<tr class="tablerow">
<td id="userId" class="copy-link">userId<span class="required">*</span></td>
<td>
Defines the user id.
</td>
<td>string</td>
<td>"78e1e841"</td>
</tr>
</tbody>
</table>
<div class="mobile-content"></div>

<span class="required-descr"><span class="required">*</span><em> - required field</em></span>

<div class="header-gray">Example</div>
<div class="header-gray">Example</div>
<pre>
const params = {
"displayName": "John Smith",
Expand All @@ -132,51 +130,50 @@ const params = {
"provider": "onlyoffice",
"userId": "78e1e841"
}
AscDesktopEditor.execCommand ("portal:login", JSON.stringify(params))
AscDesktopEditor.execCommand ("portal:login", JSON.stringify(params))
</pre>
</li>
<li id="logout" class="copy-link">
<p><b>portal:logout</b></p>
<p>When the <em>portal:logout</em> command is sent, the cloud will be removed from the list on the <b>Connected clouds</b> page.
Cookies for this domain will be cleared. Parameters are specified in the format of a string with the serialized <em>json</em> as follows:</p>
<pre>

<h2 id="logout" class="copy-link">portal:logout</b></h2>
<p>When the <em>portal:logout</em> command is sent, the cloud will be removed from the list on the <b>Connected clouds</b> page.
Cookies for this domain will be cleared. Parameters are specified in the format of a string with the serialized <em>json</em> as follows:</p>
<pre>
{
"domain": "domain name"
}
}
</pre>

<div class="header-gray">Parameters</div>
<table class="table">
<colgroup>
<col class="table-name" />
<col />
<col class="table-type" />
<col class="table-example" />
</colgroup>
<thead>
<tr class="tablerow">
<td>Name</td>
<td>Description</td>
<td>Type</td>
<td>Example</td>
</tr>
</thead>
<tbody>
<tr class="tablerow">
<td id="domain" class="copy-link">domain</td>
<td>
Defines the cloud name and the cloud entry point.
</td>
<td>string</td>
<td>"https://exampledomain.com"</td>
</tr>
</tbody>
</table>
<div class="mobile-content"></div>
<div class="header-gray">Parameters</div>
<table class="table">
<colgroup>
<col class="table-name" />
<col />
<col class="table-type" />
<col class="table-example" />
</colgroup>
<thead>
<tr class="tablerow">
<td>Name</td>
<td>Description</td>
<td>Type</td>
<td>Example</td>
</tr>
</thead>
<tbody>
<tr class="tablerow">
<td id="domain" class="copy-link">domain</td>
<td>
Defines the cloud name and the cloud entry point.
</td>
<td>string</td>
<td>"https://exampledomain.com"</td>
</tr>
</tbody>
</table>
<div class="mobile-content"></div>

<div class="header-gray">Example</div>
<pre>
<div class="header-gray">Example</div>
<pre>
window.AscDesktopEditor.execCommand ("portal:logout", JSON.stringify (({
"domain": "https://exampledomain.com"
}));
}));
</pre>
5 changes: 5 additions & 0 deletions web/Views/Desktop/Changelog.aspx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@

<p class="dscr">The list of changes for ONLYOFFICE Desktop Editors API.</p>

<h2 id="70" class="copy-link">Version 7.0</h2>
<ul>
<li>Added the <a href="<%= Url.Action("addingdms/") %>#extraLogout">extraLogout</a> parameter to the config with DMS integration parameters.</li>
</ul>

<h2 id="64" class="copy-link">Version 6.4</h2>
<ul>
<li>Added the possibility to use icons for each UI theme type in the <a href="<%= Url.Action("addingdms/") %>">config</a> with integration parameters.</li>
Expand Down
1 change: 1 addition & 0 deletions web/Views/Editors/Config/Document.ascx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
<td>
Defines the type of the file for the source viewed or edited document.
Must be lowercase.
The following file types are available: <em>.csv, .djvu, .doc, .docm, .docx, .dot, .dotm, .dotx, .epub, .fb2, .fodp, .fods, .fodt, .htm, .html, .mht, .odp, .ods, .odt, .otp, .ots, .ott, .oxps, .pdf, .pot, .potm, .potx, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf, .txt, .xls, .xlsm, .xlsx, .xlt, .xltm, .xltx, .xml, .xps</em>.
</td>
<td>string</td>
<td>"docx"</td>
Expand Down
Loading

0 comments on commit e4c19f9

Please sign in to comment.