# Storage (/zh-CN/api-reference/rtm/android/storage)

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

RTM 的 Storage 功能提供了一套动态数据库机制，可以让开发者动态设置、存储、更新、删除 Channel Metadata 和 User Metadata 等数据。

## setChannelMetadata [#setchannelmetadata]

### 接口描述 [#接口描述]

`setChannelMetadata` 方法可以为频道（Message Channel 或 Stream Channel）设置 Channel Metadata。一个频道只能有一组 Metadata，但每组 Metadata 可以有一个或多个 Metadata Item。如果多次调用该方法，SDK 会依次检索 Metadata Item 的 `key` 值，并按如下规则处理：

- 如果设置的 Metadata Item `key` 值不同，则会根据调用顺序依次增加。
- 如果设置的 Metadata Item `key` 值相同，则最后一次设置的 Metadata Item 的 `value` 会覆盖之前的值。

成功设置 Channel Metadata 后，订阅该频道且开启事件监听的用户会收到 `CHANNEL` 类型的 `onStorageEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

Channel Metadata 同时也引进了版本控制逻辑 CAS（Compare And Set），该方法提供两种独立的版本控制字段，你可以根据实际业务场景设置任意一种或多种：

- 通过 `Metadata` 中的 `majorRevision` 属性开启整组 Channel Metadata 的版本号校验。
- 通过 `MetadataItem` 中的 `revision` 属性开启某个 Metadata Item 的版本号校验。

设置 Channel Metadata 或 Metadata Item 时，配合版本属性可以控制本次调用是否开启版本号校验，逻辑如下：

- 版本属性默认为 `-1` ，本次调用不开启 CAS 验证。如果 Channel Metadata 或 Metadata Item 已存在，则该值会被最新值覆盖；如果 Channel Metadata 或 Metadata Item 不存在，则 SDK 会创建该值。
- 版本属性为正整数时，本次调用开启 CAS 验证。如果 Channel Metadata 或 Metadata Item 已存在，则 SDK 会在版本号验证成功后更新对应的值；否则 SDK 会返回错误码。

### 接口方法 [#接口方法]

你可以通过以下方式调用 `setChannelMetadata` 方法：

```java
void setChannelMetadata(
    String channelName,
    RtmChannelType channelType,
    Metadata data,
    MetadataOptions options,
    String lockName,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `channelName` | String | 必填 | - | 频道名称。 |
| `channelType` | `RtmChannelType` | 必填 | - | 频道类型。详见 [`RtmChannelType`](/zh-CN/api-reference/rtm/android/enumv#channeltype)。 |
| `data` | `Metadata` | 必填 | - | Metadata Item。详见 [`Metadata `](#metadata)。 |
| `options` | `MetadataOptions` | 必填 | - | Channel Metadata 配置选项。 |
| `lockName` | String | 必填 | - | Lock 名称。设置后，只有调用 `acquireLock` 方法获取该锁的用户才能执行操作。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-0-6-4 details](#table-slot-storage-android-html-0-6-4) |

<a id="table-slot-storage-android-html-0-6-4"></a>

**storage-android-html-0-6-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

`MetadataOptions` 数据类型包含以下属性：

|      属性      |  类型   | 是否必填 | 默认值  | 描述                      |
| ----------- | ---- | ----- | ---- | ----------- |
|   `recordTs`   | boolean |   选填   | `false` | 是否记录编辑的时间戳。    |
| `recordUserId` | boolean |   选填   | `false` | 是否记录编辑者的用户 ID。 |

### 基本用法 [#基本用法]

```java
// Create a metadata instance
Metadata metadata = new Metadata();
// Set the Major Revision
metadata.setMajorRevision(174298270);
// Add metadata item
ArrayList<MetadataItem> items = new ArrayList<MetadataItem>();
items.add(new MetadataItem("Apple", "100", 174298200));
items.add(new MetadataItem("Banana", "200", 174298100));
metadata.setItems(items);
// Record who and when set the metadata
MetadataOptions options = new MetadataOptions();
options.setRecordTs(true);
options.setRecordUserId(true);

rtmClient.getStorage().setChannelMetadata("channelName", RtmChannelType.MESSAGE, metadata, options, "lockName", new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "set channel metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## getChannelMetadata [#getchannelmetadata]

### 接口描述 [#接口描述-1]

`getChannelMetadata` 方法可以获取指定频道的 Metadata。

### 接口方法 [#接口方法-1]

你可以通过以下方式调用 `getChannelMetadata` 方法：

```java
void getChannelMetadata(
    String channelName,
    RtmChannelType channelType,
    ResultCallback<Metadata> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `channelName` | String | 必填 | - | 频道名称。 |
| `channelType` | `RtmChannelType` | 必填 | - | 频道类型。详见 [`RtmChannelType`](/zh-CN/api-reference/rtm/android/enumv#channeltype)。 |
| `resultCallback` | `ResultCallback<Metadata>` | 必填 | - | [storage-android-html-1-3-4 details](#table-slot-storage-android-html-1-3-4) |

<a id="table-slot-storage-android-html-1-3-4"></a>

**storage-android-html-1-3-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法并返回 [`Metadata `](#metadata) 查询结果。
- 调用失败：执行 `onFailure` 方法。

### 接口方法 [#接口方法-2]

```java
rtmClient.getStorage().getChannelMetadata("channelName", RtmChannelType.MESSAGE, new ResultCallback<Metadata>() {
    @Override
    public void onSuccess(Metadata data) {
        log(CALLBACK, "get channel metadata success");
        log(INFO, "metadata major revision: " + data.getMajorRevision());
        for (MetadataItem item : data.getItems()) {
            log(INFO, item.toString);
        }
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## removeChannelMetadata [#removechannelmetadata]

### 接口描述 [#接口描述-2]

`removeChannelMetadata` 方法可以删除 Channel Metadata 或 Channel Metadata Item 数组。

删除时，配合版本属性可以控制本次调用是否开启版本号校验，逻辑如下：

- 版本属性默认为 `-1` ，本次调用不开启 CAS 验证。如果 Channel Metadata 或 Metadata Item 已存在，则 SDK 会删除该值；如果 Channel Metadata 或 Metadata Item 不存在，则 SDK 会返回错误码。
- 版本属性为正整数时，本次调用开启 CAS 验证。如果 Channel Metadata 或 Metadata Item 已存在，则 SDK 会在版本号验证成功后删除对应值；否则 SDK 会返回错误码。

成功删除 Channel Metadata 或 Metadata Item 后，订阅该频道且开启事件监听的用户会收到 `CHANNEL` 类型的 `onStorageEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

### 接口方法 [#接口方法-3]

你可以通过以下方式调用 `removeChannelMetadata` 方法：

```java
void removeChannelMetadata(
    String channelName,
    RtmChannelType channelType,
    Metadata data,
    MetadataOptions options,
    String lockName,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `channelName` | String | 必填 | - | 频道名称。 |
| `channelType` | `RtmChannelType` | 必填 | - | 频道类型。详见 [`RtmChannelType`](/zh-CN/api-reference/rtm/android/enumv#channeltype)。 |
| `data` | `Metadata` | 必填 | - | Metadata Item。详见 [`Metadata `](#metadata)。 |
| `options` | `MetadataOptions` | 必填 | - | Channel Metadata 配置选项。 |
| `lockName` | String | 必填 | - | Lock 名称。设置后，只有调用 `acquireLock` 方法获取该锁的用户才能执行操作。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-2-6-4 details](#table-slot-storage-android-html-2-6-4) |

<a id="table-slot-storage-android-html-2-6-4"></a>

**storage-android-html-2-6-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

`MetadataOptions` 数据类型包含以下属性：

|      属性      |  类型   | 是否必填 | 默认值  | 描述                      |
| ----------- | ---- | ----- | ---- | ----------- |
|   `recordTs`   | boolean |   选填   | `false` | 是否记录编辑的时间戳。    |
| `recordUserId` | boolean |   选填   | `false` | 是否记录编辑者的用户 ID。 |

### 接口方法 [#接口方法-4]

```java
// Create a metadata instance
Metadata metadata = new Metadata();
// Set the Major Revision
metadata.setMajorRevision(174298270);
// Add a metadata item
MetadataItem item = new MetadataItem();
item.setKey("Apple");
item.setRevision(174298200);
metadata.getItems().add(item);
//Record who and when set the metadata
MetadataOptions options = new MetadataOptions();

rtmClient.getStorage().removeChannelMetadata("channelName", RtmChannelType.MESSAGE, metadata, options, "", new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "remove channel metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## updateChannelMetadata [#updatechannelmetadata]

### 接口描述 [#接口描述-3]

`updateChannelMetadata` 方法可以更新已有的 Channel Metadata。每次调用该方法，你可以更新一个 Channel Metadata，也可以更新一个或多个 Channel Metadata Item 数组。

成功更新后，订阅该频道且开启事件监听的用户会收到 `CHANNEL` 类型的 `onStorageEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

:::info[信息]
该方法不能对不存在的 Metadata Item 进行操作。
:::

### 接口方法 [#接口方法-5]

你可以通过以下方式调用 `updateChannelMetadata` 方法：

```java
void updateChannelMetadata(
    String channelName,
    RtmChannelType channelType,
    Metadata data,
    MetadataOptions options,
    String lockName,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `channelName` | String | 必填 | - | 频道名称。 |
| `channelType` | `RtmChannelType` | 必填 | - | 频道类型。详见 [`RtmChannelType`](/zh-CN/api-reference/rtm/android/enumv#channeltype)。 |
| `data` | `Metadata` | 必填 | - | Metadata Item。详见 [`Metadata `](#metadata)。 |
| `options` | `MetadataOptions` | 必填 | - | Channel Metadata 配置选项。 |
| `lockName` | String | 必填 | - | Lock 名称。设置后，只有调用 `acquireLock` 方法获取该锁的用户才能执行操作。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-3-6-4 details](#table-slot-storage-android-html-3-6-4) |

<a id="table-slot-storage-android-html-3-6-4"></a>

**storage-android-html-3-6-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

`options` 参数包含以下属性：

|      属性      |  类型   | 是否必填 | 默认值  | 描述                      |
| ----------- | ---- | ----- | ---- | ----------- |
|   `recordTs`   | boolean |   选填   | `false` | 是否记录编辑的时间戳。    |
| `recordUserId` | boolean |   选填   | `false` | 是否记录编辑者的用户 ID。 |

### 基本用法 [#基本用法-1]

```java
// Create a metadata instance
Metadata metadata = new Metadata();
// Set the Major Revision
metadata.setMajorRevision(174298270);
// Add metadata item
ArrayList<MetadataItem> items = new ArrayList<MetadataItem>();
items.add(new MetadataItem("Apple", "120", 174298200));
items.add(new MetadataItem("Banana", "220", 174298100));
metadata.setItems(items);

rtmClient.getStorage().updateChannelMetadata("channelName", RtmChannelType.MESSAGE, metadata, new MetadataOptions(true, true), "lockName", new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "update channel metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## setUserMetadata [#setusermetadata]

### 接口描述 [#接口描述-4]

`setUserMetadata` 方法可以设置 User Metadata。如果多次调用该方法时，SDK 会依次检索 User Metadata Item 的 `key` 值，并按如下规则处理：

- 如果设置的 Metadata Item key 值不同，则会根据调用顺序依次增加。
- 如果设置的 Metadata Item key 值相同，则最后一次设置的 Metadata 的 value 会覆盖之前的值。

成功设置 User Metadata 后，订阅该用户 Metadata 且开启事件监听的用户会收到 `USER` 类型的 `onStorageEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

User Metadata 同时也引进了版本控制逻辑 CAS，该方法提供两种独立的版本控制字段，你可以根据实际业务场景设置任意一种或多种：

- 通过 `Metadata` 中的 `majorRevision` 属性开启整组 Channel Metadata 的版本号校验。
- 通过 `MetadataItem` 中的 `revision` 属性开启某个 Metadata Item 的版本号校验。

设置 User Metadata 时，配合版本属性可以控制本次调用是否开启版本号校验，逻辑如下：

- 版本属性为 `-1` 时，本次调用不开启 CAS 验证。如果 User Metadata 或 Metadata Item 已存在，则该值会被最新值覆盖；如果 User Metadata 或 Metadata Item 不存在，则会创建该值。
- 版本属性为正整数时，本次调用开启 CAS 验证。如果 User Metadata 或 Metadata Item 已存在，则 SDK 会在版本号验证成功后更新对应的值；如果 User Metadata 或 Metadata Item 不存在，则 SDK 会返回错误码。

### 接口方法 [#接口方法-6]

你可以通过以下方式调用 `setUserMetadata` 方法：

```java
void setUserMetadata(
    String userId,
    Metadata data,
    MetadataOptions options,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `userId` | String | 必填 | - | 用户 ID。 |
| `data` | `Metadata` | 必填 | - | Metadata Item。详见 [`Metadata `](#metadata)。 |
| `options` | `MetadataOptions` | 必填 | - | Channel Metadata 配置选项。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-4-4-4 details](#table-slot-storage-android-html-4-4-4) |

<a id="table-slot-storage-android-html-4-4-4"></a>

**storage-android-html-4-4-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

`options` 参数包含以下属性：

|      属性      |  类型   | 是否必填 | 默认值  | 描述                      |
| ----------- | ---- | ----- | ---- | ----------- |
|   `recordTs`   | boolean |   选填   | `false` | 是否记录编辑的时间戳。    |
| `recordUserId` | boolean |   选填   | `false` | 是否记录编辑者的用户 ID。 |

### 基本用法 [#基本用法-2]

```java
// Create a metadata instance
Metadata metadata = new Metadata();
// Set the Major Revision
metadata.setMajorRevision(174298270);
// Add metadata item
ArrayList<MetadataItem> items = new ArrayList<MetadataItem>();
items.add(new MetadataItem("Name", "Tony", 174298200));
items.add(new MetadataItem("Mute", "true", 174298100));
metadata.setItems(items);

rtmClient.getStorage().setUserMetadata("userName", metadata, new MetadataOptions(true, true), new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "set user metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## getUserMetadata [#getusermetadata]

### 接口描述 [#接口描述-5]

`getUserMetadata` 方法可以获取指定用户的 Metadata 和 User Metadata Item。

### 接口方法 [#接口方法-7]

你可以通过以下方式调用 `getUserMetadata` 方法：

```java
void getUserMetadata(
    String userId,
    ResultCallback<Metadata> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `userId` | String | 必填 | - | 用户 `userId`。 |
| `resultCallback` | `ResultCallback<Metadata>` | 必填 | - | [storage-android-html-5-2-4 details](#table-slot-storage-android-html-5-2-4) |

<a id="table-slot-storage-android-html-5-2-4"></a>

**storage-android-html-5-2-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法并返回 [`Metadata `](#metadata) 查询结果。
- 调用失败：执行 `onFailure` 方法。

### 基本用法 [#基本用法-3]

```java
rtmClient.getStorage().getUserMetadata("userName", new ResultCallback<Metadata>() {
    @Override
    public void onSuccess(Metadata data) {
        log(CALLBACK, "get user metadata success");
        log(INFO, "major revision: " + data.getMajorRevision());
        for (MetadataItem item : data.getItems()) {
            log(INFO, item.toString());
        }
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## removeUserMetadata [#removeusermetadata]

### 接口描述 [#接口描述-6]

`removeUserMetadata` 方法可以删除 User Metadata 或某几个 User Metadata Item。

成功删除后，订阅该用户 Metadata 且开启事件监听的用户会收到 `USER` 类型的 `onStorageEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

### 接口方法 [#接口方法-8]

你可以通过以下方式调用 `removeUserMetadata` 方法：

```java
void removeUserMetadata(
    String userId,
    Metadata data,
    MetadataOptions options,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `userId` | String | 必填 | - | 用户 ID。 |
| `data` | `Metadata` | 必填 | - | Metadata Item。详见 [`Metadata `](#metadata)。 |
| `options` | `MetadataOptions` | 必填 | - | Channel Metadata 配置选项。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-6-4-4 details](#table-slot-storage-android-html-6-4-4) |

<a id="table-slot-storage-android-html-6-4-4"></a>

**storage-android-html-6-4-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

`options` 参数包含以下属性：

|      属性      |  类型   | 是否必填 | 默认值  | 描述                      |
| ----------- | ---- | ----- | ---- | ----------- |
|   `recordTs`   | boolean |   选填   | `false` | 是否记录编辑的时间戳。    |
| `recordUserId` | boolean |   选填   | `false` | 是否记录编辑者的用户 ID。 |

### 基本用法 [#基本用法-4]

```java
// Create a metadata instance
Metadata metadata = new Metadata();
// Set the Major Revision
metadata.setMajorRevision(174298270);
// Add metadata item
MetadataItem item = new MetadataItem();
item.setKey("Mute");
item.setRevision(174298100);
metadata.getItems().add(item);
// Record who and when set the metadata
MetadataOptions options = new MetadataOptions();

rtmClient.getStorage().removeUserMetadata("Tony", metadata, options, new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "remove user metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## updateUserMetadata [#updateusermetadata]

### 接口描述 [#接口描述-7]

`updateUserMetadata` 方法可以更新已有的 User Metadata 或 Metadata Item。成功更新后，订阅该 User Metadata 且开启事件监听的用户会收到 `USER` 类型的 `onStorageEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

:::info[信息]
该方法不能对不存在的 Metadata Item 进行操作。
:::

### 接口方法 [#接口方法-9]

你可以通过以下方式调用 `updateUserMetadata` 方法：

```java
void updateUserMetadata(
    String userId,
    Metadata data,
    MetadataOptions options,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `userId` | String | 必填 | - | 用户 ID。 |
| `data` | `Metadata` | 必填 | - | Metadata Item。详见 [`Metadata `](#metadata)。 |
| `options` | `MetadataOptions` | 必填 | - | Channel Metadata 配置选项。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-7-4-4 details](#table-slot-storage-android-html-7-4-4) |

<a id="table-slot-storage-android-html-7-4-4"></a>

**storage-android-html-7-4-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

`MetadataOptions` 数据类型包含以下属性：

|      属性       |  类型   | 是否必填 | 默认值  | 描述        |
| ------------ | ---- | ----- | ---- | ------------- |
| `recordTs`  | boolean |   选填   | `false` | 是否记录编辑的时间戳。            |
|   `recordUserId`   | boolean |   选填   | `false` | 是否记录编辑者的用户 ID。         |

### 基本用法 [#基本用法-5]

```java
// Create a metadata instance
Metadata metadata = new Metadata();
// Set the Major Revision
metadata.setMajorRevision(174298270);
// Add a metadata item
metadata.getItems().add(new MetadataItem("Name", "Tony", 174298200));
// Record who and when set the metadata
MetadataOptions options = new MetadataOptions();
options.setRecordTs(true);
options.setRecordUserId(true);

rtmClient.getStorage().updateUserMetadata("Tony", metadata, options, new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "update user metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## subscribeUserMetadata [#subscribeusermetadata]

### 接口描述 [#接口描述-8]

`subscribeUserMetadata` 方法可以订阅指定用户的 Metadata。成功订阅且开启事件监听后，当该用户的 Metadata 发生变更时会收到 `USER` 类型的 `onStorageEvent` 事件通知。详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

### 接口方法 [#接口方法-10]

你可以通过以下方式调用 `subscribeUserMetadata` 方法：

```java
void subscribeUserMetadata(
    String userId,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `userId` | String | 必填 | - | 用户 ID。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-8-2-4 details](#table-slot-storage-android-html-8-2-4) |

<a id="table-slot-storage-android-html-8-2-4"></a>

**storage-android-html-8-2-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

### 基本用法 [#基本用法-6]

```java
rtmClient.getStorage().subscribeUserMetadata("Tony", new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "subscribe user metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## unsubscribeUserMetadata [#unsubscribeusermetadata]

### 接口描述 [#接口描述-9]

如果你不需要接收某个用户 User Metadata 的变更通知，调用 `unsubscribeUserMetadata` 方法取消订阅。

### 接口方法 [#接口方法-11]

你可以通过以下方式调用 `unsubscribeUserMetadata` 方法：

```java
void unsubscribeUserMetadata(
    String userId,
    ResultCallback<Void> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `userId` | String | 必填 | - | 用户 ID。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [storage-android-html-9-2-4 details](#table-slot-storage-android-html-9-2-4) |

<a id="table-slot-storage-android-html-9-2-4"></a>

**storage-android-html-9-2-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

### 基本用法 [#基本用法-7]

```java
rtmClient.getStorage().unsubscribeUserMetadata("Tony", new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "unsubscribe user metadata success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## Metadata [#metadata]

设置和管理 Metadata 的数据结构。包含以下属性：

| 属性 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `majorRevision` | long | 选填 | `-1` | [storage-android-html-10-1-4 details](#table-slot-storage-android-html-10-1-4) |
| `items` | `ArrayList<MetadataItem>` | 选填 | `null` | 设置 Metadata Item。 |

<a id="table-slot-storage-android-html-10-1-4"></a>

**storage-android-html-10-1-4 details**

设置版本控制开关：

- `-1`: 关闭版本校验。
- > `0`: 开启版本校验，只有目标版本号与此值相符才能执行操作。

`MetadataItem` 数据类型包含以下属性：

| 属性 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `key` | String | 选填 | - | 键。 |
| `value` | String | 选填 | - | 值。 |
| `authorUserId` | String | 选填 | - | 编辑者的用户 ID。该值为只读，不支持写入。 |
| `revision` | long | 选填 | `-1` | [storage-android-html-11-4-4 details](#table-slot-storage-android-html-11-4-4) |
| `updateTs` | long | 选填 | `0` | 更新时间戳。该值为只读，不支持写入。 |

<a id="table-slot-storage-android-html-11-4-4"></a>

**storage-android-html-11-4-4 details**

- 在读取操作时作为真实版本号返回。
- 在写入操作时作为版本控制开关：
  -  `-1`: 关闭版本校验。
  - > `0`: 开启版本校验，只有目标版本号与此值相符才执行操作。