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

import java.util.List;
import java.util.Map;

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

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

    /**
     * 消息发送人 UserId
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Sender")
    private Long sender;

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

    /**
     * 消息类型
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "MsgType")
    private Integer msgType;

    /**
     * 消息内容。当你给客户端发消息时，Content 内容需符合客户端格式，详细信息请参看消息格式。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Content")
    private String content;

    /**
     * 会话中@的人
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "MentionedUsers")
    private List mentionedUsers;

    /**
     * 消息可见会话成员列表
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "VisibleUsers")
    private List visibleUsers;

    /**
     * 消息不可见会话成员列表。VisibleUsers 和 InvisibleUsers均为空时，代表对所有人可见。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "InvisibleUsers")
    private List invisibleUsers;

    /**
     * 消息的扩展字段
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Ext")
    private Map ext;

    /**
     * 客户端Id。如果不指定，会随机生成一个。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "ClientMsgId")
    private String clientMsgId;

    /**
     * 消息对应时间戳，单位为毫秒。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "CreateTime")
    private Long createTime;

    /**
     * 消息优先级。
     *
     *
     *
     * - `0`：低优先级。
     *
     * - `1`：普通优先级。
     *
     * - `2`：高优先级。
     *
     *
     *
     * 该字段仅对直播群有效。为避免直播群中消息频率太多导致服务端压力过大，你可以设置消息的优先级。当前直播群下，普通优先级和低优先级消息共用频控阈值为 30 条/秒，超过部分会被服务端直接丢弃。高优消息频控阈值为 10 条/秒，超过部分服务端无法保证不丢失。
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "Priority")
    private Integer priority;

    /**
     * 引用消息。该接口中，该字段只需传入`ReferencedMessageId`和`Hint`参数
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "RefMsgInfo")
    private SendMessageBodyRefMsgInfo refMsgInfo;

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