Login/logout

Before you start working on documents stored within your cloud, you need to log in to it.

Use the execCommand method of the window.AscDesktopEditor object to display the cloud in the Connected clouds list or remove it.

AscDesktopEditor.execCommand (command, parameters)
Parameters
Name Description Type
Defines the command that must be executed. string
Defines the parameters that are passed to the method. string
  1. portal:login

    When the portal:login command is sent, the cloud is registered and listed on the Connected clouds 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 json as follows:

    {
        "displayName": "user name", 
        "email": "user@email.addr",
        "domain": "domain name",
        "provider": "provider",
        "userId": "user id"
    }
    
    Parameters
    Name Description Type Example
    Defines the user name displayed on the Connected clouds page. string "John Smith"
    Defines the user email displayed on the Connected clouds page. string "john@example.com"
    Defines the cloud name and the cloud entry point. string "https://exampledomain.com"
    Defines the provider id used to refer to the desktop app in the JavaScript commands (the same as in the config). string "onlyoffice"
    Defines the user id. string "78e1e841"
    * - required field
    Example
    const params = {
        "displayName": "John Smith", 
        "email": "john@example.com",
        "domain": "https://exampledomain.com",
        "provider": "onlyoffice",
        "userId": "78e1e841"
    }
    AscDesktopEditor.execCommand ("portal:login", JSON.stringify(params))           
    
  2. portal:logout

    When the portal:logout command is sent, the cloud will be removed from the list on the Connected clouds page. Cookies for this domain will be cleared. Parameters are specified in the format of a string with the serialized json as follows:

    {
        "domain": "domain name"
    }           
    
    Parameters
    Name Description Type Example
    Defines the cloud name and the cloud entry point. string "https://exampledomain.com"
    Example
    window.AscDesktopEditor.execCommand ("portal:logout", JSON.stringify (({
        "domain": "https://exampledomain.com"
    }));