# com.herewhite.sdk.domain.ConnectionPrepareParam class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="details"></a>

## 详细描述 [#详细描述]

适用版本：**Whiteboard Android SDK 2.16.134**。

`ConnectionPrepareParam`, 定义白板房间连接准备参数。

## 属性与 JSON 字段 [#属性与-json-字段]

Java 非公开字段通过对应 getter/setter 访问；可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [appId](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#a5f32703370328616c56bd415504b1cc9) | `String appId` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#a694b4a1acf8f2a148f2b2eda2e45a8e1) | `Region region` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) |
| [expire](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#afe8e8e7a7c3b4e1d55265220f0e87843) | `Long expire` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) |

<a id="table-slot-api-center-table-0"></a>

**api-center-table-0 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-1"></a>

**api-center-table-1 details**

模型属性；通过对应 getter/setter 访问。

<a id="table-slot-api-center-table-2"></a>

**api-center-table-2 details**

模型属性；通过对应 getter/setter 访问。

| 公开成员签名 |  |
| --- | --- |
|  | [ConnectionPrepareParam](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#a16d112ac06b5ad7e66fd98a47cebf6db) (String appId, Region region) |
|  | [ConnectionPrepareParam](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#a36e35af7cb029a506b3fc87d9807a08e) (String appId, Region region, Long expire) |
| String | [getAppId](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#a84cad03748a4c62378da1ff4c34cc1c5) () |
| Region | [getRegion](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#a2e2d042dd9f114429cbc328723bbf518) () |
| Long | [getExpire](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param#a9d3436c5130cb3b50776645103b90b11) () |

## 变量说明 [#变量说明]

<a id="a5f32703370328616c56bd415504b1cc9"></a>

### appId [#appid]

```text
String appId
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="a694b4a1acf8f2a148f2b2eda2e45a8e1"></a>

### region [#region]

```text
Region region
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

<a id="afe8e8e7a7c3b4e1d55265220f0e87843"></a>

### expire [#expire]

```text
Long expire
```

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

## 函数说明 [#函数说明]

<a id="a16d112ac06b5ad7e66fd98a47cebf6db"></a>

### ConnectionPrepareParam() [#connectionprepareparam]

<ApiSignature>

ConnectionPrepareParam(String appId, Region region)

</ApiSignature>

创建一个 [`ConnectionPrepareParam`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param) 实例。

<ParameterList title="参数">
<Parameter name="appId">

白板项目的唯一标识，可在控制台获取，详见[获取白板项目的 App Identifier](/zh-CN/realtime-media/whiteboard/whiteboard-sdk/build/setup-and-access/enable-service)。

</Parameter>
<Parameter name="region">

用户的 App 所在的区域，详见 [`Region`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region)。

</Parameter>
</ParameterList>

默认在 12 小时内不再次检查连接。

<a id="a36e35af7cb029a506b3fc87d9807a08e"></a>

### ConnectionPrepareParam() [#connectionprepareparam-1]

<ApiSignature>

ConnectionPrepareParam(String appId, Region region, Long expire)

</ApiSignature>

创建一个 [`ConnectionPrepareParam`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param) 实例。

<ParameterList title="参数">
<Parameter name="appId">

白板项目的唯一标识，可在控制台获取，详见[获取白板项目的 App Identifier](/zh-CN/realtime-media/whiteboard/whiteboard-sdk/build/setup-and-access/enable-service)。

</Parameter>
<Parameter name="region">

用户的 App 所在的区域，详见 [`Region`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region)。

</Parameter>
<Parameter name="expire">

过期时间, 在该时间内不再次检查连接。默认为 12 小时。

</Parameter>
</ParameterList>

<a id="a84cad03748a4c62378da1ff4c34cc1c5"></a>

### getAppId() [#getappid]

<ApiSignature>

String getAppId()

</ApiSignature>

获取白板项目的唯一标识。

<a id="a2e2d042dd9f114429cbc328723bbf518"></a>

### getRegion() [#getregion]

<ApiSignature>

Region getRegion()

</ApiSignature>

获取用户的 App 所在的区域。

<a id="a9d3436c5130cb3b50776645103b90b11"></a>

### getExpire() [#getexpire]

<ApiSignature>

Long getExpire()

</ApiSignature>

获取过期时间。