Adobe I/ O Lib 控制台工程安装
这是一个基于模板创建和配置远程开发者控制台资源的内部助手库,例如服务和证书 install.yaml 配置文件 .
下列密钥在 install.yaml 文件 :
categories:(需要)类别是信息,必须至少界定一个类别。 见所支持的类别列表 这里。 。 。 .workspaces: (可选)要创建的工作空间名称列表. 如果运行时键设定为真,则默认会为每个工作空间添加运行时命名空间 。 如果未定义,则默认创建 Stage and Production 工作空间.runtime: (可选)定义是否为每个工作空间配置运行时间。 如果未定义,则默认为false。 。 。 .apis: (optional) Adobe服务列表,由模板要求的Adobe服务SDK代码所识别. 默认情况下,所有服务都附着在所有配置的工作空间上.
说明
apis数字 : 开发者Console支持三种类型的服务:AdobeIO,Entertainment和Analytics. 目前,本库只支持AdobeIO和企业服务进行配置.
安装
$ npm install @adobe/aio-lib-console-project-installation
使用量
- 初始化模板处理器
const { getToken } = require('@adobe/aio-lib-ims')
const { CLI } = require('@adobe/aio-lib-ims/src/context')
const templateHandler = require('@adobe/aio-lib-console-project-installation')
// Instantiate Adobe Developer Console SDK
const accessToken = await getToken(CLI)
// Instantiate App Builder Template Manager
const installConfigFile = 'install.yml'
const templateManager = await templateHandler.init(accessToken, installConfigFile)
- 使用初始化模板管理器的调用方法
// Install the template
try {
const orgId = 'org-id'
const templateId = 'template-id'
const result = await templateManager.installTemplate(orgId, templateId)
console.log(result)
} catch (e) {
console.error(e)
}
模板验证
您可以使用此库验证 App 构建程序 install.yaml 文档.
const templateHandler = require('@adobe/aio-lib-console-project-installation')
const pathToInstallConfigFile = 'install.yml'
// Second parameter is optional. Set it to `true` if you want to get prettified errors.
const { valid, errors } = await templateHandler.validate(path, true)
职能
- init( accessToken, 模板配置文件) ⇒
TemplateInstallManager 返回一个新的模板InstallManager对象.
- 校验( 模板) 档案,漂亮) ⇒
object
init( accessToken, 模板配置文件) QQ TemplateInstallManager
返回一个新的模板InstallManager对象.
仁爱:全球职能
回返数字 : TemplateInstallManager - 一个新的模板InstallManager对象.
| 参数 | 类型 | 说明 |
|---|---|---|
| 访问脚本 | string | Adobe Console API 客户端. |
| 模板配置文件 | string | 配置文件的路径 . |
校验( 模板 ) object
仁爱:全球职能
回返数字 : object - 有属性的对象 valid, (中文(简体) ), configuration 财务报告和审定财务报表 errors
| 参数 | 类型 | 默认 | 说明 |
|---|---|---|---|
| 模板配置文件 | string | 配置文件的路径 . | |
| 美丽 | boolean | false | 修饰出错. |
除错日志
LOG_LEVEL=debug <your_call_here>
预留 LOG_LEVEL 环境变量和 debug 值到引用您函数的调用,在命令行上。 这将为您的 SDK 电话输出大量调试数据 .
捐款
欢迎捐款! 读取 贡献指南 更多信息.
许可证发放
这个项目根据Apache V2许可证获得许可. 见 自由主义 更多信息.