V2NIMTeam.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamAgreeMode;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamChatBannedMode;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamInviteMode;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamJoinMode;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamType;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamUpdateExtensionMode;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamUpdateInfoMode;

/**
 * 群组定义
 */
public interface V2NIMTeam extends V2NIMTeamRefer {
    /**
     * 获取群组ID
     *
     * @return 群组ID
     */
    String getTeamId();

    /**
     * 获取群组类型
     *
     * @return 类型
     */
    V2NIMTeamType getTeamType();

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

    /**
     * 获取群组创建者/拥有者ID
     *
     * @return 群组创建者/拥有者ID
     */
    String getOwnerAccountId();

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

    /**
     * 获取群组当前人数
     *
     * @return 群组当前人数
     */
    int getMemberCount();

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

    /**
     * 获取群组更新时间
     *
     * @return 更新时间
     */
    long getUpdateTime();

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

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

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

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


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

    /**
     * 获取申请入群模式
     * @return
     */
    V2NIMTeamJoinMode getJoinMode();

    /**
     * 获取被邀请人入群模式
     * @return
     */
    V2NIMTeamAgreeMode getAgreeMode();

    /**
     * 获取群组邀请模式
     * @return
     */
    V2NIMTeamInviteMode getInviteMode();

    /**
     * 获取群组资料修改模式
     * @return
     */
    V2NIMTeamUpdateInfoMode getUpdateInfoMode();

    /**
     * 获取群组扩展字段修改模式
     * @return
     */
    V2NIMTeamUpdateExtensionMode getUpdateExtensionMode();

    /**
     * 获取群禁言状态
     * @return
     */
    V2NIMTeamChatBannedMode getChatBannedMode();

    /**
     * 是否有效的群， 群存在且我在群组中
     * @return
     */
    boolean isValidTeam();

    /**
     * 是否是有效的群
     * @return
     */
    boolean isTeamEffective();

}