UserInfoProvider.java

浏览该文件的文档.

package com.netease.nimlib.sdk.uinfo;

import android.graphics.Bitmap;
import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import com.netease.nimlib.sdk.msg.model.IMMessage;
import com.netease.nimlib.sdk.uinfo.model.UserInfo;

/**
 * 用户信息提供者
 * 由开发者提供给SDK使用
 */
public interface UserInfoProvider {

    /**
     * 根据用户帐号获取用户信息。
     *
     * @param account 用户帐号
     * @return 用户信息
     */
    UserInfo getUserInfo(String account);

    /**
     * 为通知栏提供消息发送者显示名称（例如：如果是P2P聊天，可以显示备注名、昵称、帐号等；如果是群聊天，可以显示备注名，群昵称，昵称、帐号等）
     * 如果返回 null，SDK将会使用服务器下发昵称
     * @param account     消息发送者账号
     * @param sessionId   会话ID（如果是P2P聊天，那么会话ID即为发送者账号，如果是群聊天，那么会话ID就是群号）
     * @param sessionType 会话类型
     * @return 消息发送者对应的显示名称
     */
    String getDisplayNameForMessageNotifier(String account, String sessionId, SessionTypeEnum sessionType);

    /**
     * 为云信通知栏提醒提供头像（个人、群组）
     * 一般从本地图片缓存中获取，若未下载或本地不存在，请返回默认本地头像（可以返回默认头像资源ID对应的Bitmap）
     *
     * @param sessionType 会话类型（个人、群组）
     * @param sessionId   用户账号或者群ID
     * @return 头像位图
     */
    Bitmap getAvatarForMessageNotifier(SessionTypeEnum sessionType, String sessionId);

    /**
     * 为通知栏提供消息title显示名称（例如：如果是群聊天，可以设置自定义群名称等;如果圈组，可以显示圈组频道名称等）
     * 如果返回null，SDK 群和超大群会显示群名称，其他类型将会使用当前app名称展示
     * @apiNote 不可以做耗时操作
     * @param message
     * @return 消息title显示名称
     */
    String getDisplayTitleForMessageNotifier(IMMessage message);
}