Team.java

浏览该文件的文档.

package com.netease.nimlib.sdk.team.model;

import com.netease.nimlib.sdk.team.constant.TeamAllMuteModeEnum;
import com.netease.nimlib.sdk.team.constant.TeamBeInviteModeEnum;
import com.netease.nimlib.sdk.team.constant.TeamExtensionUpdateModeEnum;
import com.netease.nimlib.sdk.team.constant.TeamInviteModeEnum;
import com.netease.nimlib.sdk.team.constant.TeamMessageNotifyTypeEnum;
import com.netease.nimlib.sdk.team.constant.TeamTypeEnum;
import com.netease.nimlib.sdk.team.constant.TeamUpdateModeEnum;
import com.netease.nimlib.sdk.team.constant.VerifyTypeEnum;

import java.io.Serializable;

/**
 * 云信群组信息的数据结构。
 */
public interface Team extends Serializable {

    /**
     * 获取群组ID
     *
     * @return 群组ID
     */
    public String getId();

    /**
     * 获取群组名称
     *
     * @return 群组名称
     */
    public String getName();

    /**
     * 获取群头像
     *
     * @return
     */
    public String getIcon();

    /**
     * 获取群组类型
     *
     * @return 类型
     */
    public TeamTypeEnum getType();

    /**
     * 获取群组公告
     *
     * @return 公告
     */
    public String getAnnouncement();

    /**
     * 获取群组简介
     *
     * @return 简介
     */
    public String getIntroduce();

    /**
     * 获取创建群组的用户帐号
     *
     * @return 创建者的用户帐号
     */
    public String getCreator();

    /**
     * 获取群组的总成员数
     *
     * @return 成员数
     */
    public int getMemberCount();

    /**
     * 获取群组的成员人数上限
     *
     * @return 成员人数上限
     */
    public int getMemberLimit();

    /**
     * 获取申请加入群组时的验证类型
     *
     * @return 验证类型
     */
    public VerifyTypeEnum getVerifyType();

    /**
     * 获取群组的创建时间
     *
     * @return 创建时间
     */
    public long getCreateTime();

    /**
     * 获取自己是否在这个群里
     *
     * @return 自己是否在这个群里
     */
    public boolean isMyTeam();

    /**
     * 设置群组扩展配置。<br>
     * 通常情况下，该配置应是一个json或xml串，以增强扩展能力。
     *
     * @param extension 扩展配置
     */
    public void setExtension(String extension);

    /**
     * 获取群组扩展配置。<br>
     * 该字段由第三方APP自由定义和解释，云信仅负责存储和透传。
     *
     * @return 扩展配置
     */
    public String getExtension();

    /**
     * 获取服务器设置的扩展配置。<br>
     * 和{@link #getExtension()}一样，云信不解释该字段，仅负责存储和透传。<br>
     * 不同于{@link #getExtension()}, 该配置只能通过服务器接口设置，对客户端是只读的。
     *
     * @return 服务器设置的扩展配置项
     */
    public String getExtServer();

    /**
     * 获取这个群收到新消息时要不要提醒的设置。
     *
     * @return 如果返回true，不提醒，否则会提醒。
     * <p>
     * 请使用 {@link #getMessageNotifyType()} 替代
     */
    @Deprecated
    public boolean mute();

    /**
     * 获取当前账号在此群收到消息之后提醒的类型
     * 普通群只支持全部禁言、全部提醒两种提醒类型
     *
     * @return TeamMessageNotifyTypeEnum
     */
    public TeamMessageNotifyTypeEnum getMessageNotifyType();

    /**
     * 获取群邀请模式：谁可以邀请他人入群
     *
     * @return 群邀请模式枚举
     */
    public TeamInviteModeEnum getTeamInviteMode();

    /**
     * 获取群被邀请模式：被邀请人的同意方式
     *
     * @return 群被邀请模式枚举
     */
    public TeamBeInviteModeEnum getTeamBeInviteMode();

    /**
     * 获取群资料修改模式：谁可以修改群资料
     *
     * @return 群资料修改模式枚举
     */
    public TeamUpdateModeEnum getTeamUpdateMode();

    /**
     * 获取群资料扩展字段修改模式：谁可以修改群自定义属性(扩展字段)
     *
     * @return 群资料扩展字段修改模式枚举
     */
    public TeamExtensionUpdateModeEnum getTeamExtensionUpdateMode();

    /**
     * 是否群全员禁言
     *
     * @return true：全员禁言，false：未禁言
     */
    public boolean isAllMute();

    /**
     * 获取群禁言模式
     *
     * @return TeamAllMuteModeEnum
     */
    public TeamAllMuteModeEnum getMuteMode();
}