GFPlatformBridgeRequest¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/platform/gf_platform_bridge_request.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
8.0.0
平台桥接请求。 用纯数据描述从 GF 或项目侧发往外部平台 adapter 的一次调用。它不执行调用， 只为 JS bridge、native SDK bridge 或进程桥接提供统一请求载体。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | request_id |
var request_id: StringName = &"" |
| 属性 | contract_id |
var contract_id: StringName = &"" |
| 属性 | method_id |
var method_id: StringName = &"" |
| 属性 | payload |
var payload: Dictionary = {} |
| 属性 | timeout_msec |
var timeout_msec: int = 0 |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 方法 | configure |
func configure( p_request_id: StringName, p_contract_id: StringName, p_method_id: StringName, p_payload: Dictionary = {}, p_timeout_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformBridgeRequest: |
| 方法 | is_empty |
func is_empty() -> bool: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | duplicate_request |
func duplicate_request() -> GFPlatformBridgeRequest: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFPlatformBridgeRequest: |
属性¶
request_id¶
- API：
public - 首次版本：
8.0.0
请求 ID。
contract_id¶
- API：
public - 首次版本：
8.0.0
桥接契约 ID。
method_id¶
- API：
public - 首次版本：
8.0.0
方法 ID。
payload¶
- API：
public - 首次版本：
8.0.0
请求载荷。
结构：
payload: Dictionary adapter-defined request payload.
timeout_msec¶
- API：
public - 首次版本：
8.0.0
超时时间，单位毫秒；小于等于 0 表示由调用方决定。
metadata¶
- API：
public - 首次版本：
8.0.0
调用方元数据。
结构：
metadata: Dictionary caller-defined request metadata.
方法¶
configure¶
- API：
public - 首次版本：
8.0.0
func configure( p_request_id: StringName, p_contract_id: StringName, p_method_id: StringName, p_payload: Dictionary = {}, p_timeout_msec: int = 0, p_metadata: Dictionary = {} ) -> GFPlatformBridgeRequest:
配置桥接请求。
参数：
| 名称 | 说明 |
|---|---|
p_request_id |
请求 ID。 |
p_contract_id |
桥接契约 ID。 |
p_method_id |
方法 ID。 |
p_payload |
请求载荷。 |
p_timeout_msec |
超时时间，单位毫秒。 |
p_metadata |
调用方元数据。 |
返回：当前请求。
结构：
p_payload: Dictionary adapter-defined request payload.p_metadata: Dictionary caller-defined request metadata.
is_empty¶
- API：
public - 首次版本：
8.0.0
检查请求是否缺少最小契约字段。
返回：缺少 request_id、contract_id 或 method_id 时返回 true。
to_dict¶
- API：
public - 首次版本：
8.0.0
转换为字典。
返回：桥接请求字典。
结构：
return: Dictionary platform bridge request.
apply_dict¶
- API：
public - 首次版本：
8.0.0
从字典应用桥接请求字段。
参数：
| 名称 | 说明 |
|---|---|
data |
桥接请求字典。 |
结构：
data: Dictionary platform bridge request.
duplicate_request¶
- API：
public - 首次版本：
8.0.0
创建桥接请求深拷贝。
返回：新桥接请求。
from_dict¶
- API：
public - 首次版本：
8.0.0
从字典创建桥接请求。
参数：
| 名称 | 说明 |
|---|---|
data |
桥接请求字典。 |
返回：新桥接请求。
结构：
data: Dictionary platform bridge request.