TIM-java-sdk

Данный проект представляет собой пакет инструментов для разработки Java-версии сервисов облачной коммуникации от компании Tencent.

Прогресс

• Управление аккаунтами ✅💯
• Управление личными сообщениями
• Управление онлайн-статусом ✅💯
• Управление цепочками отношений ✅💯
• Управление данными ✅💯
• Управление группами (в процессе, 80%)
• Управление нецензурными словами
• Глобальное управление блокировкой
• Управление операциями

Подготовка

• В IDE настройте поддержку плагина Lombok.
• Используйте JDK версии 1.8 или выше.
• Настройте среду Maven.

Конфигурация

TIMConfig

appId           : 腾讯云腾讯SDKID
adminIdentifier : 管理员账号
privateKeyPath  : 地址管理员私钥文件
accountType     : accountType 管理员
reqMaxRetry     : 请求最大重试数

Использование

TIMConfig config = new TIMConfig(...);
TIMService timService = new TIMServiceImpl(config);

// Добавить друзей
try{
    timService.getRelationService().importFriends(...)
}catch(TIMException e){
    if(e.getError().getErrorCode() == 30010){
        // Уже достигнуто максимальное количество друзей в системе
    }
}


// Дополнительные интерфейсы см. в документации или интерфейсе com.sevlow.sdk.tim.api

Разработка

Интерфейсы определены в com.sevlow.sdk.tim.api, а методы интерфейса реализованы в com.sevlow.sdk.tim.api.impl. Параметры структуры Req и Resp, необходимые для интерфейса, хранятся в com.sevlow.sdk.tim.bean.

Компиляция

mvn clean install

Тестирование

Настройка параметров

Скопируйте файл config.test.example.yml из папки /src/test/resources и переименуйте его в config.test.yml. Введите соответствующие настройки для облачной связи Tencent в config.test.yml, при этом параметр privateKeyPath может указывать на абсолютный путь к файлу или вы можете поместить файл в папку /src/test/resources и переименовать его в private_key.example.txt.

Файлы private_key.example.txt и config.test.yml были проигнорированы в файле .gitignore, чтобы избежать их отправки в открытый репозиторий.

Примеры тестов

После завершения написания кода перейдите в папку /src/test/java, где вы найдёте соответствующие примеры тестов. Вы можете следовать инструкциям внутри для написания тестов.

Для тестирования используется TestNG.

В качестве инструмента внедрения зависимостей используется com.google.inject:guice.

Вклад в код

1. Форкните этот проект.
2. Клонируйте свой форк.
3. Добавьте адрес этого репозитория в качестве удалённого репозитория.

git remote add upstream https://github.com/forfuns/TIMJava.git

4. Регулярно синхронизируйте содержимое своего репозитория с этим проектом.

git fetch upstream
git checkout develop
git rebase upstream/develop
git push origin develop

5. Переключитесь на ветку develop.
6. Разрабатывайте код на своей ветке и ветке develop, а также пишите тесты.
7. Отправьте PR (Pull request) в этот проект.