Forge Jira桥 API
注册自定义域 UIM 处理器
customFieldApi.registerUIMHandlers 允许选择的 Forge 对象自定义字段
在其挂载视图或编辑运行时间中验证 UIM 值和选项可见性建议 .
这个API需要有一个Jira主机,并启用完成的自控器能力.
拒绝的旧主机 error.code === 'FCF_UIM_HANDLERS_UNSUPPORTED'。 。 。 .
使用 isFcfError(error) 在树枝之前 error.code 在一个 catch (error: unknown) 块.
import { customFieldApi, isFcfError, type UIMHandlers } from '@forge/jira-bridge';
type Service = { id: string; name: string };
const handlers: UIMHandlers<Service> = {
setValue(proposed, context) {
// Validate the caller and proposed value using your app's domain policy.
// Return a canonical JSON object, or null to clear the field.
return { accepted: true, value: proposed };
}
};
const registration = await customFieldApi.registerUIMHandlers(handlers);
// When this runtime unmounts:
await registration.unregister();
setValue 财务报告和审定财务报表 setOptionsVisibility 独立选择。 登记无论是,
或空处理器地图。 没有请求的处理器的注册运行时间
不支持这项行动: FCF_OPERATION_UNSUPPORTED
通过UIM的错误通道而不应用建议. 缺失的注册
仍然遵循东道主的准备规则. 两个处理器都支持同步
和同步结果: { accepted: true, value } 或者说
{ accepted: false, code, message? }。 。 。 . null 清除对象字段, undefined, (中文(简体) ),
非JSON值和错误结果无效。 Jira验证和适用已接受
通过其现有形式或持久性途径取得结果。 帮手不能坚持
建议或呼吁 view.submit 他们自己.
东道方用品 callerAppId, (中文(简体) ), fieldId, (中文(简体) ), requestId, (中文(简体) ), renderContext, (中文(简体) ),
currentValue 财务报告和审定财务报表 optionsVisibility。这些描述UIM的引用,而不是
提供经认证的应用软件解析器出处。 UIM 设置保持同步
可连锁,应用失败通过 uiModificationsApi.onError。 。 。 .
注册在主机存储可调用处理器后解决. 注册一次
每个挂载运行时间。 重新登记取代运行时的处理器,处理一个
旧的登记不能取消替换. unregister() 返回等元符
承诺并立即禁用本地调用, 即使主机清理拒绝 .
申请清理还必须处理卸载后解决的登记.
保留 isUIModificationsEnabled: true 在现有的 jira:customField 或者说
jira:customFieldType 模块。 没有额外的显示资源或通用桥 API
所需经费。 主机部署和控制的应用程序迁移必须先于一般使用,
旧主机保留其先前的对象- UIM 行为 .