-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
77 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,82 @@ | ||
| # ONLYOFFICE DocSpace JavaScript SDK | ||
|
|
||
| ## Overview | ||
| ## Basic concepts | ||
|
|
||
| The ONLYOFFICE DocSpace SDK based on JavaScript allows developers to use all the DocSpace possibilities with api.js. | ||
| The ONLYOFFICE DocSpace SDK based on JavaScript allows developers to use all the DocSpace possibilities with *api.js*. You can integrate ONLYOFFICE DocSpace into your own web application, allowing users to create and submit documents directly from your website. For example, you can use the ONLYOFFICE DocSpace [React component](https://api.onlyoffice.com/docspace/javascript-sdk/get-started/react-component/) to integrate ONLYOFFICE DocSpace into React projects. | ||
|
|
||
| You can integrate ONLYOFFICE DocSpace into your own web application, allowing users to create and submit documents directly from your website. | ||
| You don't need to be an experienced JavaScript developer to use the DocSpace JavaScript SDK because we provide you with all the basics. You only need a few lines of JavaScript to set up a fully functional integration. | ||
|
|
||
| You don't need to be an experienced JavaScript developer to use the DocSpace JavaScript SDK because we provide you with all the basics. You only need a few lines of JavaScript to set up a fully functional integration. | ||
| Follow the steps below to connect DocSpace as a frame to your website. | ||
|
|
||
| ## Step 1. Specifying the DocSpace URL | ||
|
|
||
| For the JavaScript SDK to work correctly, it must be launched on the server. Note that running the HTML file directly will not work. Please make sure you are using a server environment. | ||
|
|
||
| You need to add the URL of your server's root directory to the **Developer Tools** section of DocSpace: | ||
|
|
||
| 1. Go to the DocSpace settings. | ||
| 2. Navigate to the **Developer Tools** section. | ||
| 3. On the **JavaScript SDK** tab, in the **Enter the address of DocSpace to embed** field, add the URL of your server's root directory. | ||
|
|
||
| ## Step 2. Creating the HTML file | ||
|
|
||
| Create the target HTML file which must include a placeholder *div* tag, where all the information about DocSpace parameters will be passed: | ||
|
|
||
| ``` html | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>DocSpace JavaScript SDK</title> | ||
| <script src="{PORTAL_SRC}/static/scripts/sdk/1.0.0/api.js"></script> | ||
| </head> | ||
| <body> | ||
| <div id="ds-frame"></div> | ||
| </body> | ||
| </html> | ||
| ``` | ||
|
|
||
| The API JavaScript file can normally be found in the following DocSpace folder: | ||
|
|
||
| `{PORTAL\_SRC}/static/scripts/sdk/1.0.0/api.js` | ||
|
|
||
| where **{PORTAL\_SRC}** is the name of the server with the ONLYOFFICE DocSpace installed. | ||
|
|
||
| ## Step 3. Getting the base class | ||
|
|
||
| When the API JavaScript is connected to the page, get the base class that provides all the basic functionality of *api.js*: | ||
|
|
||
| | Class | Description | | ||
| | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | DocSpace.SDK | Defines the DocSpace document manager and allows you to perform operations with rooms, folders, and documents within the DocSpace portal. | | ||
|
|
||
| ## Step 4. Authorizing | ||
|
|
||
| *api.js* uses the active DocSpace application sessions to authenticate users. If the user is logged in to the DocSpace portal that the SDK will connect to, then *api.js* recognizes and uses that active session. | ||
|
|
||
| If the users are not authenticated, they will see a page asking them to sign in to DocSpace the first time they use it. Authentication is also possible through the SDK [methods](https://api.onlyoffice.com/docspace/javascript-sdk/usage-sdk/methods/#login). | ||
|
|
||
| ## Step 5. Initializing | ||
|
|
||
| > Please note that when working via HTTPS, it is necessary to set the **"SameSite": "none"** parameter in *appsettings.json* to avoid blocking the work with cookies during cross-domain requests. | ||
| Initialize DocSpace frame using the [initFrame](https://api.onlyoffice.com/docspace/javascript-sdk/usage-sdk/methods/#initframe) method with the SDK config passed to it: | ||
|
|
||
| ``` ts | ||
| const docSpace = DocSpace.SDK.initFrame({ | ||
| frameId: "frameId", | ||
| showMenu: true, | ||
| }) | ||
| ``` | ||
|
|
||
| You can use other available [methods](https://api.onlyoffice.com/docspace/javascript-sdk/usage-sdk/methods/) to initialize DocSpace. | ||
|
|
||
| The full list of [config parameters](https://api.onlyoffice.com/docspace/javascript-sdk/usage-sdk/config/) can be found here. | ||
|
|
||
| ## Step 6. Using | ||
|
|
||
| After initialization, the current SDK instance can be accessed by using its [frameId](https://api.onlyoffice.com/docspace/javascript-sdk/usage-sdk/config/#frameid). The list of current SDK instances is available in the *DocSpace.SDK.frames* array. To get the specific SDK instance, use the following string: | ||
|
|
||
| ``` ts | ||
| DocSpace.SDK.frames[frameId] | ||
| ``` |