登录和登出
在开始处理存储在云盘中的文档之前,您需要先登录到云盘。
登录
使用 execCommand 方法在已连接的云盘列表中显示云盘。当发送 portal:login 命令时,云盘将被注册并显示在已连接的云盘页面上。在登录云盘后可访问的所有页面上调用此命令。参数以包含序列化 json 的字符串格式指定,如下所示:
{
"displayName": "用户名",
"email": "用户邮箱地址",
"domain": "域名",
"provider": "提供商",
"uiTheme": "主题",
"userId": "用户ID"
}
| 参数 | 类型 | 示例 | 描述 |
|---|---|---|---|
| displayName | string | "John Smith" | 在已连接的云盘页面上显示的用户名。此字段为必填项。 |
| string | "john@example.com" | 在已连接的云盘页面上显示的用户邮箱。 | |
| domain | string | "https://exampledomain.com" | 云盘名称和云盘入口点。此字段为必填项。 |
| provider | string | "onlyoffice" | 用于在 JavaScript 命令中引用桌面应用的提供商 ID(与 配置 中的相同)。此字段为必填项。 |
| uiTheme | string or object | "theme-dark" | 云在标签栏中的标签颜色:已安装主题的 ID(例如 theme-dark)、default-dark 或 default-light,或包含 type(dark 或 light)和 color(十六进制颜色)字段的对象。仅支持 Windows 和 Linux。 |
| userId | string | "78e1e841" | 用户 ID。此字段为必填项。 |
示例
const params = {
displayName: "John Smith",
email: "john@example.com",
domain: "https://exampledomain.com",
provider: "onlyoffice",
uiTheme: "theme-dark",
userId: "78e1e841",
};
window.AscDesktopEditor.execCommand("portal:login", JSON.stringify(params));
登出
使用 execCommand 方法从已连接的云盘列表中移除云盘。当发送 portal:logout 命令时,该云盘将从已连接的云盘页面的列表中移除。此域名的 Cookie 将被清除。参数以包含序列化 json 的字符串格式指定,如下所示:
{
"domain": "域名"
}
示例
window.AscDesktopEditor.execCommand("portal:logout", JSON.stringify({
domain: "https://exampledomain.com",
}));