API 概览 - IM 即时通讯 UIKit

更新时间： 2024/08/12 14:47:11

本文介绍在网易云信即时通讯 IM UIKit（简称 NIM UIKit）层因为上层业务需要，在 NIM UIKit 层提供的接口。NIM UIKit 层接口位于 ChatKit 模块中，该模块提供 UI 层使用到的会话、通讯录、群、消息等相关接口。

类列表

在 ChatKit 层中接口主要分布在如下类中：

类名	概述
`IMKitConfigCenter`	NIM UIKit 配置中心，配置 NIM UIKit 相关功能开关，具体接口参考 IMKitConfigCenter。
`AIRepo`	AI 数字人接口类，提供 AI 数字人获取和变更监听方法等。
`ChatRepo`	消息相关接口类，提供消息发送、撤回、接受监听等。
`ContactRepo`	通讯录相关接口，好友、黑名单相关接口等。
`ConversationRepo`	会话相关业务逻辑接口该类根据 UI 层业务逻辑，提供会话相关的数据获取、设置等操作，通过 IM SDK V2NIMConversationService 提供的接口实现。
`MiscRepo`	SDK 杂项业务逻辑接口该类根据 UI 层业务逻辑，提供 SDK 杂项相关的数据获取、设置等操作，通过 IM SDK MiscService 提供的接口实现。
`ResourceRepo`	资源相关业务逻辑接口。
`SearchRepo`	好友和群组相关搜索接口 UIKit 业务实现搜索功能。
`SettingRepo`	设置相关业务逻辑接口。
`TeamRepo`	群组相关接口为 TeamKit-ui 模块中业务提供群组相关接口，根据业务需求对 SDK 接口进行组合封装。

IMKitConfigCenter

提供 NIM UIKit 功能配置开关，可以对已实现的功能进行全局控制。如是否使用@功能、PIN 功能等。

参数	参数类型	说明
`enableAIUser`	[Boolean]	是否使用 AI 数字人，默认 true。
`enableAtMessage`	[Boolean]	是否使用@功能，默认 true。
`enableCollectionMessage`	[Boolean]	是否使用消息收藏功能，默认 true。
`enableDismissTeamDeleteConversation`	[Boolean]	是否解散群或者被踢出群聊后删除会话，默认 true。
`enableOnlyFriendCall`	[Boolean]	是否只能和好友通话默认 true。
`enablePinMessage`	[Boolean]	是否使用 Pin 消息功能，默认 true。
`enableTeam`	[Boolean]	是否使用群功能默认 true，如果为 false，将不会出现跟群相关功能，默认 true。
`enableTopMessage`	[Boolean]	是否使用消息置顶功能，默认 true。
`enableTypingStatus`	[Boolean]	是否支持正在输入状态功能，默认 true。

功能设置需要在 NIM UIKit 功能或者页面加载之前配置，推荐在 Application 或者 Activity 的 onCreate 方法中设置 NIM UIKit 的配置。以 enableAIUser 接口为例，设置方法如下所示：

Application：

Javapublic class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        
        // 在这里设置 NIM UIKit 的配置
        IMKitConfigCenter.setEnableAIUser(false);
    }
}

Activity：

Javapublic class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        
        setContentView(R.layout.activity_main);
        
        // 在这里设置 NIM UIKit 的配置
        IMKitConfigCenter.setEnableAIUser(false);
    }
}

此文档是否对你有帮助？

有帮助

去反馈

类列表
IMKitConfigCenter