com.volcengine.model.im.ScanConversationParticipantListBody Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of volc-sdk-java Show documentation

The VOLC Engine SDK for Java

There is a newer version: 1.0.192

package com.volcengine.model.im;


import com.alibaba.fastjson.JSON;

/**
 * ScanConversationParticipantListBody
 */
@lombok.Data
public final class ScanConversationParticipantListBody  {

    /**
     * 应用的唯一标志
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "AppId")
    private Integer appId;

    /**
     * 会话 ID
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "ConversationShortId")
    private Long conversationShortId;

    /**
     * 查询起始位置
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Cursor")
    private Long cursor;

    /**
     * 查询人数
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Limit")
    private Long limit;

    /**
     * 按照进群的时间正序或逆序查询。
     *
     *
     *
     * - `false`：正序。
     *
     * - `true`：逆序。
     *
     *
     *
     * 默认值为：`fasle`。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Reverse")
    private Boolean reverse;

    /**
     * 是否只查询群成员 `UserId`。
     *
     *
     *
     * - `true`：是。
     *
     * - `false`：否。
     *
     *
     *
     * 默认值为 `false`。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "OnlyUserIds")
    private Boolean onlyUserIds;

    /**
     * 直播群专用字段。是否需要获得直播群在线成员列表。
     *
     *
     *
     * - `true`：是：拉取直播群在线成员列表（包含群主和管理员，只要在线就会返回，非直播群不会返回任何数据）。
     *
     * - `false`：否：拉取成员列表（非直播群），拉取群主管理员（直播群）。
     *
     *
     *
     * 默认值为 `false`。

     *
     * 当此字段设置 `true` 时，`Reverse` 和 `OnlyUserIds` 字段均会失效，该接口按成员进入直播群时间逆序返回在线成员列表。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "ScanOnlineParticipant")
    private Boolean scanOnlineParticipant;

    /**
     * 标记类型。仅支持查询具有该标记的在线成员。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "MarkType")
    private String markType;

    @Override
    public String toString() {
        return JSON.toJSONString(this);
    }
}