com.volcengine.model.im.GetBlackListBody 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;

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

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

    /**
     * 被查询用户的 UserId
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "UserId")
    private Long userId;

    /**
     * 信箱，用做逻辑隔离。默认值为 `0`
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "InboxType")
    private Integer inboxType;

    /**
     * 查询起始位置，按照添加顺序逆序查询。默认值为 `0`，即最后一个添加至黑名单的用户。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Cursor")
    private Long cursor;

    /**
     * 查询条数，每次最多查询 20 位用户。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Limit")
    private Long limit;

    /**
     * 是否需要黑名单用户总数。
     *
     *
     *
     * - `false`：不需要。
     *
     * - `true`：需要。
     *
     *
     *
     * 默认值为 `false`。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "NeedTotal")
    private Boolean needTotal;

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