createMobileTemplateEditor(初始化)

编辑器实例化API参数说明

编辑器实例化，这是你使用编辑器 API 的前置过程。

通过CDN方式

会在 window 对象中添加一个 gaoding 字段, 开发者可通过 gaoding 对象进行实例化编辑器

<!DOCTYPE html>
<html>
    <head>
        <script src="https://open.gaoding.com/assets/editor-sdk-v2.js"></script>
    </head>
    <body>
        <script type="text/javascript">
            const editor = window.gaoding.createMobileTemplateEditor({
                appId: '在稿定开放平台应用详情里查看',
            });
        </script>
    </body>
</html><code><!DOCTYPE html>
<html>
    <head>
        <script src="https://open.gaoding.com/assets/editor-sdk-v2.js"></script>
    </head>
    <body>
        <script type="text/javascript">
            const editor = window.gaoding.createMobileTemplateEditor({
                appId: '在稿定开放平台应用详情里查看',
            });
        </script>
    </body>
</html></code>

通过 npm 方式

import { createMobileTemplateEditor } from '@gaoding/editor-sdk';
const editor = createMobileTemplateEditor({
    appId: '在稿定开放平台应用详情里查看',
});<code>import { createMobileTemplateEditor } from '@gaoding/editor-sdk';
const editor = createMobileTemplateEditor({
    appId: '在稿定开放平台应用详情里查看',
});</code>

实例化参数

options.appId(必填)

类型: string

使用的应用ID，可在控制台-应用详情-基础信息查看

const editor = createMobileTemplateEditor({
    appId: 'xxxxx',
});<code>const editor = createMobileTemplateEditor({
    appId: 'xxxxx',
});</code>

options.container(必填)

类型: string | HTMLElement

选择嵌入的元素容器。填写 container 后，编辑器将会嵌入在指定的容器中

const editor = createMobileTemplateEditor({
    appId: 'xxxxx',
    container: '#app'
});<code>const editor = createMobileTemplateEditor({
    appId: 'xxxxx',
    container: '#app'
});</code>

options.authorize（必填）

类型: () => Promise<string>

进行开发者系统的用户账户与稿定系统的账户绑定，开启该功能后，使用编辑器的用户不需要手动登录稿定账户。而是在打开编辑器时，通过开发者提供的授权码进行登录。点击查看获取稿定账户授权码文档。

const editor = createMobileTemplateEditor({
    appId: 'xxxxx',
    async authorize() {
        // 与开放者自己的服务器通信，返回用户授权码
      	return fetch('/gaoding/authorize')
          	.then(res => res.json())
          	.then(res => {
                // 请确认该返回值是字符串
                console.log(res.data.code);
                return res.data.code;
            })
    }
});<code>const editor = createMobileTemplateEditor({
    appId: 'xxxxx',
    async authorize() {
        // 与开放者自己的服务器通信，返回用户授权码
      	return fetch('/gaoding/authorize')
          	.then(res => res.json())
          	.then(res => {
                // 请确认该返回值是字符串
                console.log(res.data.code);
                return res.data.code;
            })
    }
});</code>

options.getUseRightCert

仅配置了 authorize 参数时生效

类型: (info: { appId: string; abilityCode: string; workId: string; }) => Promise<string | false | Error>

当平台方允许用户下载作品时，用该方法可获取权益凭证。 目前 abilityCode 只有 TE002 。当用户点击保存时触发。要求开放者返回一个凭证字符串。如果开放者返回 false 或者 Error 时，则判断为开发者拒接用户使用凭证。因为该函数支持返回 Promise 开放者也可以在这钩子函数中做用户的权益相关判断。比如付费操作等。点击查看扣减权益文档。