环信API方法介绍

叁歲伎倆 2024-03-23 11:51 86阅读 0赞

#### 安装 ####

如果你的项目使用Maven构建并且spring boot是2.4.3以上版本，可以在pom.xml中添加下面代码：

<dependency>
        <groupId>com.easemob.im</groupId>
        <artifactId>im-sdk-core</artifactId>
        <version>0.2.5</version>
    </dependency>

如果你使用的spring-boot是2.4.3以下版本的，还需要在pom.xml中添加:

<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>io.netty</groupId>
                <artifactId>netty-bom</artifactId>
                <version>4.1.59.Final</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>io.projectreactor</groupId>
                <artifactId>reactor-bom</artifactId>
                <version>2020.0.4</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

#### 准备 ####

在使用Server SDK之前，需要准备环信appkey、Client ID、ClientSecre。

如果你有环信管理后台账号并创建过应用，请先登录环信管理后台，点击[ 这里][Link 1]，然后到“应用列表” → 点击“查看”即可获取到appkey、Client ID、ClientSecret。

![1c52a381280c4e648995a8e08bb41be7.png][]

#### 使用 ####

[EMService][]是所有API的入口，可以这样初始化：

EMProperties properties = EMProperties.builder()
            .setAppkey(cliProperties.getAppkey())
            .setClientId(cliProperties.getClientId())
            .setClientSecret(cliProperties.getClientSecret())
            .build();
    
    EMService service = new EMService(properties);

根据业务资源，API分为：

*  [Attachment][] 用于上传下载附件
 *  [Block][] 用于限制访问
 *  [Contact][] 用于管理联系人
 *  [Group][] 用于管理群组
 *  [Message][] 用于发送消息
 *  [User][] 用于管理用户
 *  [Room][] 用于管理聊天室

[Link 1]: https://console.easemob.com/user/login
[1c52a381280c4e648995a8e08bb41be7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/7cd8178604f64946a9ff9628250cc507.png
[EMService]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/EMService.html
[Attachment]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/attachment/AttachmentApi.html
[Block]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/block/BlockApi.html
[Contact]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/contact/ContactApi.html
[Group]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/group/GroupApi.html
[Message]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/message/MessageApi.html
[User]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/user/UserApi.html
[Room]: https://easemob.github.io/easemob-im-server-sdk/com/easemob/im/server/api/room/RoomApi.html