Microsoft CIFramework 提供了使用 JavaScript API 管理 Dynamics 365 模型驱动应用中的通信面板、记录和窗体的方法。
重要
- 在调用其他 API 之前，必须调用 CIFInitDone 事件处理程序 。
- API 的超时限制为 10 秒。 如果 API 未在 10 秒内运行，则必须使用更改的参数或范围再次运行它们。
通信面板管理 API
作为代理，您与客户互动的沟通面板是您与客户互动的地方。 使用此面板加载使用 Channel Integration Framework 1.0 构建的合作伙伴小组件。 此版本中的小部件显示在屏幕右侧，并支持停靠和最小化模式。
使用以下 API 来管理通信面板（小组件）的状态。
| Methods | Description |
|---|---|
| 设置宽度 | 设置所有会话的面板宽度。 |
| 获取宽度 | 获取面板宽度（以像素为单位）。 |
| 设置模式 | 设置面板的状态。 |
| 获取模式 | 设置面板的状态。 |
CRUD作 API
使用以下 API 对实体记录执行 CRUD作。
| Methods | Description |
|---|---|
| 创建记录 | 创建实体记录。 |
| 检索记录 | 检索实体记录。 |
| 更新记录 | 更新实体记录。 |
| 删除记录 | 删除实体记录。 |
杂项方法
| Methods | Description |
|---|---|
| getEntityMetadata | 返回指定实体的实体元数据。 |
| setClickToAct | 设置布尔值以启用或禁用出站通信 （ClickToAct）。 |
| getClickToAct | 返回一个布尔值，以指示是否启用了出站通信 （ClickToAct）。 |
| searchAndOpenRecords | 该方法在入站通信期间从通信小组件中搜索记录并打开记录。 |
| 获取环境 | 获取当前的统一接口应用和页面详细信息。 详细信息包括应用程序 ID（appid）、pageType（pageType）、记录 ID（id）、组织地理位置 （orgGeo） 和会话导航类型 （navigationType）。 |
| 开放表格 | 打开实体窗体或快速创建窗体。 |
| 渲染搜索页面 | 允许您在特定实体类型的记录中搜索。 此 API 将打开统一接口实体页面，其中的搜索字段预填充了作为参数传递的搜索字符串。 |
| addHandler | 将订阅者添加到事件中。
注释 此 API 可用于小组件和统一接口页面。 |
| removeHandler | 从事件中删除订阅者。
注释 此 API 可用于小组件和统一接口页面。 |
| raise 事件 | 调用事件的关联订阅者。
注释 如果已使用 addHandler 方法创建了自定义事件，则可以通过在此方法中将事件名称作为参数传递来引发这些事件。 |
| 更新上下文 | 此方法允许您设置自动化字典。 |