对话框

2026-11-05评分加载中…

一、功能介绍

对话框能让插件在 Pilot 界面上弹出标准样式的弹窗,把提示、确认、输入、单选、多选等交互交给 Pilot 统一呈现,无需插件自己绘制 UI。用户的操作结果(点了哪个按钮、输入了什么、选了哪些项)通过回调传回插件。所有弹窗方法都是同步调用、同步返回一个 OperationResult 表示是否成功弹出。

1.1 能力总览

对话框类型描述
提示框只展示信息,单一确认
确认框展示信息,提供确认 / 取消两个按钮
输入框让用户输入文本
单选框让用户从多个选项中选一个
多选框让用户从多个选项中选多个

1.2 应用场景

  • 操作确认:执行高风险动作前弹确认框二次确认
  • 参数录入:弹输入框让用户填写航线名称等文本
  • 选项选择:弹单选 / 多选框让用户选择作业模式或图层

二、接口调用示例

以下示例假设你已完成 SDK 初始化,且插件与 Pilot 已连接就绪(连接状态获取见插件连接状态文档)。所有接口都通过管理器单例 RemoteDialogManager.getInstance() 调用。

弹窗内容通过 DialogConfig(Builder 模式)描述,用户操作结果通过 config 上注册的监听回调传回。五个弹窗方法都同步返回 OperationResult,据此判断是否成功弹出(如已有弹窗时返回 DIALOG_ALREADY_EXISTS)。

2.1 提示框与确认框(showAlertDialog / showConfirmDialog)

提示框只需标题和内容;确认框额外配两个按钮及其点击回调:

val dialogManager = RemoteDialogManager.getInstance()           // 获取管理器单例

// 提示框:仅展示信息
val alertConfig = DialogConfig.Builder()
    .setTitle("上传完成")
    .setMessage("资源已成功上传到 Pilot")
    .setOnDismiss { /* 弹窗关闭 */ }
    .build()
val result = dialogManager.showAlertDialog(alertConfig)
if (result == OperationResult.DIALOG_ALREADY_EXISTS) { /* 已有弹窗,避免重复弹出 */ }

// 确认框:确认 / 取消两个按钮
val confirmConfig = DialogConfig.Builder()
    .setTitle("确认删除")
    .setMessage("删除后不可恢复,是否继续?")
    .setStartButtonText("取消")
    .setEndButtonText("删除")
    .setOnStartButtonClick { /* 点了取消 */ }
    .setOnEndButtonClick { /* 点了删除 */ }
    .build()
dialogManager.showConfirmDialog(confirmConfig)

效果预览:

对话框

提示框

对话框

确认框

2.2 输入框 / 单选框 / 多选框(showPromptDialog / showSingleChoiceDialog / showMultiChoiceDialog)

这三类弹窗通过 DialogElementConfig 列表描述输入项 / 选项,用户提交后在 setOnMessage 回调的 DialogMessage 里读取结果——buttonType 是点击的按钮位置,inputTexts 是输入内容,selectedIndexes 是选中项下标:

// 单选框:给出若干选项
val singleConfig = DialogConfig.Builder()
    .setTitle("选择作业模式")
    .setElementConfigs(listOf(
        DialogElementConfig().apply { selectionItem = "巡检模式" },
        DialogElementConfig().apply { selectionItem = "测绘模式" },
        DialogElementConfig().apply { selectionItem = "监控模式" }
    ))
    .setStartButtonText("取消")
    .setEndButtonText("确定")
    .setOnMessage { message ->
        if (message.buttonType == DialogButtonPosition.END) {
            val chosen = message.selectedIndexes                // 选中项下标列表(单选只有一个)
        }
    }
    .build()
dialogManager.showSingleChoiceDialog(singleConfig)

常见变体:

  • 输入框:改用 showPromptDialog,DialogElementConfig 设 inputHint / inputPrefill,在回调里读 message.inputTexts。
  • 多选框:改用 showMultiChoiceDialog,选项 DialogElementConfig 可预设 isSelected,回调 message.selectedIndexes 返回多个下标。

效果预览:

对话框

输入框

对话框

单选框

对话框

多选框

三、API 参考

以下接口方法的完整定义(含入参数据模型、枚举)请查看 API 文档:IRemoteDialogManageropen in new window。

IRemoteDialogManager 是对话框管理接口总入口,对外开放以下方法:

项说明
IRemoteDialogManager对话框管理接口总入口
showAlertDialog弹提示框,返回 OperationResult
showConfirmDialog弹确认框,返回 OperationResult
showPromptDialog弹输入框,返回 OperationResult
showSingleChoiceDialog弹单选框,返回 OperationResult
showMultiChoiceDialog弹多选框,返回 OperationResult

四、Sample 源码获取

对话框 Sampleopen in new window


五、常见问题(FAQ)

Q1:弹窗方法返回 DIALOG_ALREADY_EXISTS 怎么办?

Pilot 上已经有一个弹窗在显示。对话框不允许叠加,需等当前弹窗关闭(触发 onDismiss)后再弹下一个,或在弹出前根据返回值判断,避免重复调用。

Q2:如何拿到用户的输入 / 选择结果?

在 DialogConfig 上通过 setOnMessage 注册回调,用户提交后会回调 DialogMessage:buttonType(点击的按钮位置,START / END / NONE)、inputTexts(输入框文本列表)、selectedIndexes(单选 / 多选的选中下标列表)。按弹窗类型读取对应字段即可。

Q3:返回 SERVICE_NOT_FOUND 或 EXECUTION_FAILED?

  • SERVICE_NOT_FOUND:连接未就绪(delegate 未注入)。等连接状态 CONNECTED 后重试。
  • EXECUTION_FAILED:跨进程调用异常。检查 DialogConfig 是否构造完整后重试。

Q4:对话框接口为什么不用错误码回调,而是返回 OperationResult?

弹窗是同步命令:调用后立即知道能否成功弹出,因此用同步返回的 OperationResult 枚举表示结果(如 SUCCESS / DIALOG_ALREADY_EXISTS / SERVICE_NOT_FOUND)。用户后续的交互结果才通过 onMessage 等回调异步传回。

附录:OperationResult 速查

以下取值来自 dji.open.pilot.base.ui.model.OperationResult:

取值含义
SUCCESS成功弹出
DIALOG_ALREADY_EXISTS已有弹窗在显示;见 Q1
SERVICE_NOT_FOUND连接未就绪;见 Q3
EXECUTION_FAILED跨进程调用异常;见 Q3
NOT_SUPPORTED当前页面 / 场景不支持该弹窗
DIALOG_NOT_SUPPORTED_ON_CURRENT_PAGE当前页面不支持弹窗
最近修改: