Skip to content

Latest commit

 

History

History
83 lines (57 loc) · 2.79 KB

README.md

File metadata and controls

83 lines (57 loc) · 2.79 KB
Raw

Tencent Cloud IM Server SDK in Java

maven license prs welcome open-source-organization

The Tencent Cloud IM Server SDK for Java enables Java developers to easily work with Tencent Cloud IM.

中文文档

Documentation

https://doocs.github.io/qcloud-im-server-sdk-java

Quick Start

1. Add Dependency

Note: Tencent Cloud IM Server SDK requires JDK 1.8 or later.

If you're using Maven, just add the following dependency in pom.xml.

<dependency>
  <groupId>io.github.doocs</groupId>
  <artifactId>im-server-sdk-java</artifactId>
  <version>0.4.08</version>
</dependency>

If not, you can download JAR in Maven Center Repository.

2. Getting Started

Here is a quick teaser of an application using Tencent Cloud IM Server SDK in Java:

// sdk appId
long appId = 1400554812;

// admin userId
String userId = "test";

// application key
String key = "60c6c5925f3ae52c7325ac5a8ec78e44c056d1dd84d54e12ffa39911267a2a70";

// create ImClient instance
ImClient client = ImClient.getInstance(appId, userId, key);

// import account
AccountImportRequest request = new AccountImportRequest("doocs");
request.setFaceUrl("https://avatars.githubusercontent.com/u/43716716?s=200&v=4");
request.setNick("Doocs Community");
try {
    AccountImportResult result = client.account.accountImport(request);
    // handle result
} catch (IOException e) {
    // handle exception
}

Contributing

Contributions are always welcomed!

We use the dev branch as the development branch, which indicates that this is a unstable branch.

Here are the workflow for contributors:

  1. Fork to your own
  2. Clone fork to local repository
  3. Create a new branch and work on it
  4. Keep your branch in sync
  5. Commit your changes (make sure your commit message concise)
  6. Push your commits to your forked repository
  7. Create a pull request

Please refer to CONTRIBUTING for detailed guidelines.

License

Apache-2.0 License.