# com.herewhite.sdk.domain.AkkoEvent class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event)

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

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

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

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

`AkkoEvent` 类，用于设置自定义事件。

父类：[WhiteObject](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object)；继承接口详见父类。

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

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

| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [eventName](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event#a133be6043b5c7602fdbcf935ca7cec83) | `String eventName` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [payload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event#af8deb443f7d63d8f64e26ba54f18d17b) | `Object payload` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) |

<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 访问。

| 公开成员签名 |  |
| --- | --- |
|  | [AkkoEvent](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event#aa3e32a4dfa4910fe84da4469571ea4ee) (String eventName, Object payload) |
| String | [getEventName](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event#a3a7cf1f6b478a9452914f9ab8197bbdc) () |
| void | [setEventName](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event#a5f7505bc470028d2740952313baee893) (String eventName) |
| Object | [getPayload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event#aa9f15c32968dee2c81ce67c35313a95a) () |
| void | [setPayload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event#a23bbaafb3594e2e769ed285855b91fed) (Object payload) |

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

<a id="a133be6043b5c7602fdbcf935ca7cec83"></a>

### eventName [#eventname]

```text
String eventName
```

源码初值：未显式赋值

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

<a id="af8deb443f7d63d8f64e26ba54f18d17b"></a>

### payload [#payload]

```text
Object payload
```

源码初值：未显式赋值

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

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

<a id="aa3e32a4dfa4910fe84da4469571ea4ee"></a>

### AkkoEvent() [#akkoevent]

<ApiSignature>

AkkoEvent(String eventName, Object payload)

</ApiSignature>

[`AkkoEvent`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-akko-event) 构造方法，用于初始化自定义事件。

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

自定义事件名称

</Parameter>
<Parameter name="payload">

自定义事件信息，必须为 [`WhiteObject`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object) 子类，以保证数据格式正确。

</Parameter>
</ParameterList>

<a id="a3a7cf1f6b478a9452914f9ab8197bbdc"></a>

### getEventName() [#geteventname]

<ApiSignature>

String getEventName()

</ApiSignature>

获取自定义事件的名称。

<h4 data-toc-hidden="true" id={"返回值"}>返回值</h4>

自定义事件的名称。

<a id="a5f7505bc470028d2740952313baee893"></a>

### setEventName() [#seteventname]

<ApiSignature>

void setEventName(String eventName)

</ApiSignature>

设置自定义事件的名称。

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

自定义事件的名称。

</Parameter>
</ParameterList>

<a id="aa9f15c32968dee2c81ce67c35313a95a"></a>

### getPayload() [#getpayload]

<ApiSignature>

Object getPayload()

</ApiSignature>

设置自定义事件的内容。

<h4 data-toc-hidden="true" id={"返回值-1"}>返回值</h4>

自定义事件的内容。

<a id="a23bbaafb3594e2e769ed285855b91fed"></a>

### setPayload() [#setpayload]

<ApiSignature>

void setPayload(Object payload)

</ApiSignature>

设置自定义事件的内容。

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

自定义事件的内容，必须为 [`WhiteObject`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object) 子类，以保证数据格式正确。

</Parameter>
</ParameterList>