V2NIMTeamInviteParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.team.params;

import java.util.List;

/**
 * V2NIMTeamInviteParams类用于定义邀请成员加入群的参数。
 */
public class V2NIMTeamInviteParams {

    /**
     * 被邀请加入群的成员账号列表。
     * 该字段为必填项，不能为null，且列表大小不能为0，否则会返回参数错误。
     */
    private List<String> inviteeAccountIds;

    /**
     * 邀请入群的附言。
     * 该字段为可选项，可以为null。
     */
    private String postscript;

    /**
     * 邀请入群的扩展字段。
     * 目前仅支持高级群，超大群暂不支持。
     * 该字段为可选项，可以为null，最大长度为512个字符。
     */
    private String serverExtension;

    /**
     * 获取被邀请加入群的成员账号列表。
     *
     * @return 被邀请加入群的成员账号列表
     */
    public List<String> getInviteeAccountIds() {
        return inviteeAccountIds;
    }

    /**
     * 设置被邀请加入群的成员账号列表。
     *
     * @param inviteeAccountIds 被邀请加入群的成员账号列表
     */
    public void setInviteeAccountIds(List<String> inviteeAccountIds) {
        this.inviteeAccountIds = inviteeAccountIds;
    }

    /**
     * 获取邀请入群的附言。
     *
     * @return 邀请入群的附言
     */
    public String getPostscript() {
        return postscript;
    }

    /**
     * 设置邀请入群的附言。
     *
     * @param postscript 邀请入群的附言
     */
    public void setPostscript(String postscript) {
        this.postscript = postscript;
    }

    /**
     * 获取邀请入群的扩展字段。
     *
     * @return 邀请入群的扩展字段
     */
    public String getServerExtension() {
        return serverExtension;
    }

    /**
     * 设置邀请入群的扩展字段。
     *
     * @param serverExtension 邀请入群的扩展字段
     */
    public void setServerExtension(String serverExtension) {
        this.serverExtension = serverExtension;
    }

    public boolean isValid() {
        return inviteeAccountIds != null && !inviteeAccountIds.isEmpty();
    }

}