GFPlatformBridgeResult¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/platform/gf_platform_bridge_result.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
8.0.0
平台桥接结果。 用纯数据表达外部平台 adapter 对一次桥接请求的成功、失败、状态、返回值和耗时。 它不包含平台 SDK 依赖，也不假设同步或异步实现方式。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | request_id |
var request_id: StringName = &"" |
| 属性 | contract_id |
var contract_id: StringName = &"" |
| 属性 | method_id |
var method_id: StringName = &"" |
| 属性 | ok |
var ok: bool = false |
| 属性 | status |
var status: StringName = &"" |
| 属性 | value |
var value: Variant = null |
| 属性 | error |
var error: String = "" |
| 属性 | started_at_msec |
var started_at_msec: int = 0 |
| 属性 | completed_at_msec |
var completed_at_msec: int = 0 |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | configure_success |
func configure_success( request: GFPlatformBridgeRequest, p_value: Variant = null, p_status: StringName = &"ok", p_started_at_msec: int = 0, p_completed_at_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformBridgeResult: |
| 方法 | configure_failure |
func configure_failure( request: GFPlatformBridgeRequest, p_error: String, p_status: StringName = &"failed", p_started_at_msec: int = 0, p_completed_at_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformBridgeResult: |
| 方法 | get_duration_msec |
func get_duration_msec() -> int: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_result |
func duplicate_result() -> GFPlatformBridgeResult: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFPlatformBridgeResult: |
属性¶
request_id¶
- API：
public - 首次版本：
8.0.0
请求 ID。
contract_id¶
- API：
public - 首次版本：
8.0.0
桥接契约 ID。
method_id¶
- API：
public - 首次版本：
8.0.0
方法 ID。
ok¶
- API：
public - 首次版本：
8.0.0
是否成功。
status¶
- API：
public - 首次版本：
8.0.0
状态码。
value¶
- API：
public - 首次版本：
8.0.0
返回值。
结构：
value: Adapter-defined result value.
error¶
- API：
public - 首次版本：
8.0.0
错误描述。
started_at_msec¶
- API：
public - 首次版本：
8.0.0
开始时间戳，单位毫秒。
completed_at_msec¶
- API：
public - 首次版本：
8.0.0
完成时间戳，单位毫秒。
metadata¶
- API：
public - 首次版本：
8.0.0
调用方元数据。
结构：
metadata: Dictionary caller-defined result metadata.
方法¶
configure_success¶
- API：
public - 首次版本：
8.0.0
func configure_success( request: GFPlatformBridgeRequest, p_value: Variant = null, p_status: StringName = &"ok", p_started_at_msec: int = 0, p_completed_at_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformBridgeResult:
配置成功结果。
参数：
| 名称 | 说明 |
|---|---|
request |
对应请求。 |
p_value |
返回值。 |
p_status |
状态码。 |
p_started_at_msec |
开始时间戳。 |
p_completed_at_msec |
完成时间戳；小于等于 0 时使用 Time.get_ticks_msec()。 |
p_metadata |
调用方元数据。 |
返回：当前结果。
结构：
p_value: Adapter-defined result value.p_metadata: Dictionary caller-defined result metadata.
configure_failure¶
- API：
public - 首次版本：
8.0.0
func configure_failure( request: GFPlatformBridgeRequest, p_error: String, p_status: StringName = &"failed", p_started_at_msec: int = 0, p_completed_at_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformBridgeResult:
配置失败结果。
参数：
| 名称 | 说明 |
|---|---|
request |
对应请求。 |
p_error |
错误描述。 |
p_status |
状态码。 |
p_started_at_msec |
开始时间戳。 |
p_completed_at_msec |
完成时间戳；小于等于 0 时使用 Time.get_ticks_msec()。 |
p_metadata |
调用方元数据。 |
返回：当前结果。
结构：
p_metadata: Dictionary caller-defined result metadata.
get_duration_msec¶
- API：
public - 首次版本：
8.0.0
获取耗时，单位毫秒。
返回：完成时间减开始时间；缺少时间戳时返回 0。
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：桥接结果字典。
结构：
return: Dictionary platform bridge result.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用桥接结果字段。
参数：
| 名称 | 说明 |
|---|---|
data |
桥接结果字典。 |
结构：
data: Dictionary platform bridge result.
duplicate_result¶
- API：
public - 首次版本：
8.0.0
创建桥接结果深拷贝。
返回：新桥接结果。
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建桥接结果。
参数：
| 名称 | 说明 |
|---|---|
data |
桥接结果字典。 |
返回：新桥接结果。
结构：
data: Dictionary platform bridge result.