You need to enable JavaScript to run this app.
导航
用户资料
最近更新时间:2024.05.16 10:55:02首次发布时间:2024.05.16 10:55:02

本文档提供用户资料的功能使用说明。你可以通过用户资料功能模块实现用户头像、昵称等字段的自定义,无需自行建设用户资料逻辑。

API 接口详细文档参看 Android API 参考iOS API 参考Web API 参考微信小程序 API 参考

前提条件

参看构建基础应用集成使用 IM SDK,版本 v1.2.0 以上。
注册用户 后才能正常使用用户资料功能。
Web 端 / 小程序端需要在实例化时传入 ContactPlugin

import { BytedIM, ContactPlugin } from '@volcengine/im-web-sdk'; // 小程序为 @volcengine/im-mp-sdk
const bytedIMInstance = new BytedIM({/* 省略 options */}, [ContactPlugin]);
核心功能

设置用户资料

使用 setUserSelfPortrait 设置用户头像。

BIMClient.getInstance().getService(BIMContactExpandService.class).setUserSelfPortrait(url, new BIMResultCallback<BIMUserFullInfo>() {
            @Override
            public void onSuccess(BIMUserFullInfo bimUserProfile) {
            
            }

            @Override
            public void onFailed(BIMErrorCode code) {
     
            }
        })

使用 setUserSelfNickName 设置用户昵称。

BIMClient.getInstance().getService(BIMContactExpandService.class).setUserSelfNickName(nickName, new BIMResultCallback<BIMUserFullInfo>() {
            @Override
            public void onSuccess(BIMUserFullInfo bimUserProfile) {
          
            }

            @Override
            public void onFailed(BIMErrorCode code) {
            }
        });

使用 setUserSelfExt 设置用户额外信息。

BIMClient.getInstance().getService(BIMContactExpandService.class).setUserSelfExt(ext, new BIMResultCallback<BIMUserFullInfo>() {
            @Override
            public void onSuccess(BIMUserFullInfo bimUserProfile) {
     
            }

            @Override
            public void onFailed(BIMErrorCode code) {
            }
        });

获取用户信息

使用 getUserFullInfo 获取用户信息。

BIMClient.getInstance().getService(BIMContactExpandService.class).getUserFullInfo(showUid, true,new BIMResultCallback<BIMUserFullInfo>() {
            @Override
            public void onSuccess(BIMUserFullInfo fullInfo) {
                
            }

            @Override
            public void onFailed(BIMErrorCode code) {
            }
        });

使用 getUserFullInfoList 批量获取用户信息。

BIMClient.getInstance().getService(BIMContactExpandService.class).getUserFullInfoList(addIdList, new BIMResultCallback<List<BIMUserFullInfo>>() {
            @Override
            public void onSuccess(List<BIMUserFullInfo> userFullInfos) {
           
            }

            @Override
            public void onFailed(BIMErrorCode code) {

            }
        });

好友资料变更监听

使用 addFriendListener 用户资料变更后,好友将收到用户资料变更的回调。

BIMClient.getInstance().getService(BIMContactExpandService.class).addFriendListener(new BIMFriendListener() {
            ...
            
            @Override
            public void onUserProfileUpdate(BIMUserFullInfo userFullInfo) {
                //好友信息变更回调
            }
        });