Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
I
im-common
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
陈永峰
im-common
Commits
784a12cf
Unverified
Commit
784a12cf
authored
Nov 19, 2021
by
Yang Libin
Committed by
GitHub
Nov 19, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: update readme guideline (#67)
parent
91b43192
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
94 additions
and
14 deletions
+94
-14
README.md
README.md
+13
-13
README_CN.md
README_CN.md
+80
-0
quickstart.md
docs/guide/quickstart.md
+1
-1
No files found.
README.md
View file @
784a12cf
...
...
@@ -7,16 +7,20 @@
The Tencent Cloud IM Server SDK for Java enables Java developers to easily work with Tencent Cloud IM.
## Requirements
[
中文文档
](
./README_CN.md
)
-
Java 8 or later
-
Maven
## Documentation
## Installation and Getting Started
-
[
Documentation Home
](
https://doocs.github.io/qcloud-im-server-sdk-java
)
-
[
Contributing Code
](
#Contributing
)
##
# 1. Maven Configuration
##
Quick Start
Add the Maven dependency:
### 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`
.
```
xml
<dependency>
...
...
@@ -26,9 +30,11 @@ Add the Maven dependency:
</dependency>
```
If not, you can download JAR in
[
Maven Center Repository
](
https://repo1.maven.org/maven2/io/github/doocs/im-server-sdk-java/
)
.
### 2. Getting Started
Here is a quick teaser of an application using
IM
SDK in Java:
Here is a quick teaser of an application using
Tencent Cloud IM Server
SDK in Java:
```
java
// sdk appId
...
...
@@ -55,12 +61,6 @@ try {
}
```
## Authors
-
[
Yang Libin
](
https://github.com/yanglbme
)
-
[
Hong Yiheng
](
https://github.com/hongyiheng
)
-
[
Xie Yu
](
https://github.com/YXxy1002
)
## Contributing
Contributions are always welcomed!
...
...
README_CN.md
0 → 100644
View file @
784a12cf
# 腾讯云 IM 服务端 Java SDK
<a
href=
"https://search.maven.org/artifact/io.github.doocs/im-server-sdk-java"
><img
src=
"https://img.shields.io/maven-metadata/v?color=42b883&metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fio%2Fgithub%2Fdoocs%2Fim-server-sdk-java%2Fmaven-metadata.xml&style=flat-square"
alt=
"maven"
></a>
<a
href=
"https://github.com/doocs/qcloud-im-server-sdk-java/blob/main/LICENSE"
><img
src=
"https://img.shields.io/github/license/doocs/qcloud-im-server-sdk-java?color=42b883&style=flat-square"
alt=
"license"
></a>
<a
href=
"https://github.com/doocs/qcloud-im-server-sdk-java/pulls"
><img
src=
"https://img.shields.io/badge/prs-welcome-42b883?style=flat-square"
alt=
"prs welcome"
></a>
<a
href=
"https://doocs.github.io/#/?id=how-to-join"
><img
src=
"https://img.shields.io/badge/organization-join%20us-42b883?style=flat-square"
alt=
"open-source-organization"
></a>
腾讯云 IM 服务端 Java SDK 封装了
[
腾讯云即时通信 IM
](
https://cloud.tencent.com/document/product/269
)
服务端的所有 API 接口,方便服务端开发者进行 REST API 接口的调用以第三方回调的处理。
[
English Version
](
./README.md
)
## 文档导航
-
[
文档站点
](
https://doocs.github.io/qcloud-im-server-sdk-java
)
-
[
贡献代码
](
#Contributing
)
## 快速上手
### 1. 添加依赖
**注意**
: 腾讯云 IM 服务端 Java SDK 依赖 JDK 1.8 及以上版本。
如果你的应用程序属于 Maven 工程,请在
`pom.xml`
文件中引入以下依赖:
```
xml
<dependency>
<groupId>
io.github.doocs
</groupId>
<artifactId>
im-server-sdk-java
</artifactId>
<version>
0.2.10
</version>
</dependency>
```
你也可以在
[
Maven 中央仓库
](
https://repo1.maven.org/maven2/io/github/doocs/im-server-sdk-java/
)
下载 SDK 的 JAR 包,并在项目中引入。
### 2. 编码实现
```
java
// sdk appId
long
appId
=
1400554812
;
// 管理员 userId
String
userId
=
"test"
;
// 应用程序 key
String
key
=
"60c6c5925f3ae52c7325ac5a8ec78e44c056d1dd84d54e12ffa39911267a2a70"
;
// 创建 IM 客户端实例
ImClient
client
=
ImClient
.
getInstance
(
appId
,
userId
,
key
);
// 导入帐号
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
);
// 结果处理
}
catch
(
IOException
e
)
{
// 异常捕捉处理
}
```
## 参与项目
我们非常欢迎各位开发者参与完善 SDK!
本项目,我们使用
`dev`
作为开发分支,如果你希望参与本项目,请参考以下步骤:
1.
将本项目 fork 到你的个人帐号下
2.
将 fork 后的项目 clone 到你本地项目
3.
创建一个新的分支,并添加你的变更
4.
将你的分支与我们上游最新代码保持同步
5.
Commit 提交你的分支,注意 commit msg 的格式保持简洁明了
6.
将你的代码 Push 到你在第一步中 fork 下来的项目中
7.
创建一个 Pull Request,请求将你的代码合并到我们 dev 分支
更多详情,请参考
[
CONTRIBUTING
](
./CONTRIBUTING.md
)
文档指南。
## 许可证
Apache-2.0 许可证。
docs/guide/quickstart.md
View file @
784a12cf
...
...
@@ -20,7 +20,7 @@
implementation
group:
'io.github.doocs'
,
name:
'im-server-sdk-java'
,
version:
'0.2.10'
```
### 下载
jar
### 下载
JAR
[
Maven 中央仓库
](
https://repo1.maven.org/maven2/io/github/doocs/im-server-sdk-java/
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment