stream chat net

Официальный .NET SDK для потокового чата

Официальный .NET API Клиент для потокового чата, услуга для приложений по строительству чата.
Изучите документы »

Образцы кода · Ошибка отчета · Функция запроса

О потоке

Вы можете подписаться на учетную запись потока на нашей странице «Начало работы».

Вы можете использовать эту библиотеку для доступа к API API-точкам в чате.

Для клиентских интеграций (Web и Mobile) посмотрите на библиотеки JavaScript, iOS и Android SDK (DOCS).

---

Нарушение изменений в v1.0 <

Библиотека получила много изменений в v1.0, чтобы упростить использование и более хорошо подлежащие инстанции в будущем. Основное изменение заключается в том, что классы Channel и Client были разделены на небольшие модули, которые мы называем клиентами. (Это также возобновляет структуру нашей библиотеки Java.) Основные изменения:

• Классы Channel и Client исчезли и были организованы в более мелких клиентов в пространстве имен StreamChat.Clients .
• Эти клиенты не сохраняют состояние, как Channel , который использовался ранее, где он держал channelType и channelId в памяти. Таким образом, это означает, что вам нужно перейти в channelType и channelId на множество вызовов методов в IChannelClient .
• Асинхронные имена методов имеют Async суффикс сейчас.
• Все публичные методы и классы имеют документацию.
• Идентификаторы были переименованы из ID в Id , чтобы следовать руководству по именованию Microsoft. Например, userID -> userId .
• Многие классы данных были переименованы, чтобы иметь больше смысла. Такие как ChannelObject -> Channel .
• Классы данных были перемещены в пространство имен StreamChat.Models .
• Полная функция функции: все API -интерфейсы доступны.
• Возвращенными значениями являются тип ApiResponse и разоблачение предела скорости Informaiton с помощью метода GetRateLimit() .
• Структура папок проекта была реорганизована, чтобы следовать рекомендации Microsoft.
• Модульные тесты были улучшены. Они меньше, более сфокусированы и имеют методы очистки.
• Добавлена поддержка .NET 6.0.

Правильное использование библиотеки:

 var clientFactory = new StreamClientFactory ( "YourApiKey" , "YourApiSecret" ) ;
// Note: all client instances can be used as a singleton for the lifetime
// of your application as they don't maintain state.
var userClient = clientFactory . GetUserClient ( ) ;
var channelClient = clientFactory . GetChannelClient ( ) ;
var messageClient = clientFactory . GetMessageClient ( ) ;
var reactionClient = clientFactory . GetReactionClient ( ) ;

var jamesBond = await userClient . UpsertAsync ( new UserRequest { Id = "james_bond" } ) ;
var agentM = await userClient . UpsertAsync ( new UserRequest { Id = "agent_m" } ) ;

var channel = await channelClient . GetOrCreateAsync ( "messaging" , "superHeroChannel" , createdBy : jamesBond . Id ) ;
await channelClient . AddMembersAsync ( channel . Type , channel . Id , jamesBond . Id , agentM . Id ) ;

var message = await messageClient . SendMessageAsync ( channel . Type , channel . Id , jamesBond . Id , "I need a new quest Agent M." ) ;
await reactionClient . SendReactionAsync ( message . Id , "like" , agentM . Id ) ; 

---

Установка

$ dotnet add package stream-chat-net

Совет: вы можете найти образцы кода в папке образцов.

Начиная

Импорт

 using StreamChat . Clients ;

Инициализировать клиент

 // Client factory instantiation.
var clientFactory = new StreamClientFactory ( "YourApiKey" , "YourApiSecret" ) ;

// Or you can configure some options such as custom HttpClient, HTTP timeouts etc.
var clientFactory = new StreamClientFactory ( "YourApiKey" , "YourApiSecret" , opts => opts . Timeout = TimeSpan . FromSeconds ( 5 ) ) ;

// Get clients from client factory. Note: all clients can be used as a singleton in your application.
var channelClient = clientFactory . GetChannelClient ( ) ;
var messageClient = clientFactory . GetMessageClient ( ) ;

Создайте токен для использования на стороне клиента

 var userClient = clientFactory . GetUserClient ( ) ;

// Without expiration
var token = userClient . CreateToken ( "bob-1" ) ;

// With expiration
var token = userClient . CreateToken ( "bob-1" , expiration : DateTimeOffset . UtcNow . AddHours ( 1 ) ) ;

Создать/обновить пользователей

 var userClient = clientFactory . GetUserClient ( ) ;

var bob = new UserRequest
{
    Id = "bob-1" ,
    Role = Role . Admin ,
    Teams = new [ ] { "red" , "blue" } // if multi-tenant enabled
} ;
bob . SetData ( "age" , 27 ) ;

await userClient . UpsertAsync ( bob ) ;

// Batch update is also supported
var jane = new UserRequest { Id = "jane" } ;
var june = new UserRequest { Id = "june" } ;
var users = await userClient . UpsertManyAsync ( new [ ] { bob , jane , june } ) ;

GDPR-подобные пользовательские конечные точки

 var userClient = clientFactory . GetUserClient ( ) ;

await userClient . ExportAsync ( "bob-1" ) ;
await userClient . DeactivateAsync ( "bob-1" ) ;
await userClient . ReactivateAsync ( "bob-1" ) ;
await userClient . DeleteAsync ( "bob-1" ) ;

Типы каналов

 var channelTypeClient = clientFactory . GetChannelTypeClient ( ) ;

var chanTypeConf = new ChannelTypeWithStringCommands
{
    Name = "livechat" ,
    Automod = Automod . Disabled ,
    Commands = new List < string > { Commands . Ban } ,
    Mutes = true
} ;
var chanType = await channelTypeClient . CreateChannelTypeAsync ( chanTypeConf ) ;

var allChanTypes = await channelTypeClient . ListChannelTypesAsync ( ) ;

Каналы

 var channelClient = clientFactory . GetChannelClient ( ) ;

// Create a channel with members from the start, Bob is the creator
var channel = channelClient . GetOrCreateAsync ( "messaging" , "bob-and-jane" , bob . Id , bob . Id , jane . Id ) ;

// Create channel and then add members, Mike is the creator
var channel = channelClient . GetOrCreateAsync ( "messaging" , "bob-and-jane" , mike . Id ) ;
channelClient . AddMembersAsync ( channel . Type , channel . Id , bob . Id , jane . Id , joe . Id ) ;

Обмен сообщениями

 var messageClient = clientFactory . GetMessageClient ( ) ;

// Only text
messageClient . SendMessageAsync ( channel . Type , channel . Id , bob . Id , "Hey, I'm Bob!" ) ;

// With custom data
var msgReq = new MessageRequest { Text = "Hi june!" } ;
msgReq . SetData ( "location" , "amsterdam" ) ;

var bobMessageResp = await messageClient . SendMessageAsync ( channelType , channel . Id , msgReq , bob . Id ) ;

// Threads
var juneReply = new MessageRequest { Text = "Long time no see!" } ;
var juneReplyMessage = await messageClient . SendMessageToThreadAsync ( channel . Type , channel . Id , juneReply , june . Id , bobMessageResp . Message . Id )

Реакция

 var reactionClient = clientFactory . GetReactionClient ( ) ;

await reactionClient . SendReactionAsync ( message . Id , "like" , bob . Id ) ;

var allReactions = await reactionClient . GetReactionsAsync ( message . Id ) ;

Умеренность

 var channelClient = clientFactory . GetChannelClient ( ) ;
var userClient = clientFactory . GetUserClient ( ) ;
var flagClient = clientFactory . GetFlagClient ( ) ;

await channelClient . AddModeratorsAsync ( channel . Type , channel . Id , new [ ] { jane . Id } ) ;

await userClient . BanAsync ( new BanRequest
{
    Type = channel . Type ,
    Id = channel . Id ,
    Reason = "reason" ,
    TargetUserId = bob . Id ,
    UserId = jane . Id
} ) ;

await flagClient . FlagUserAsync ( bob . Id , jane . Id ) ;

Разрешения

 var permissionClient = clientFactory . GetPermissionClient ( ) ;

await permissionClient . CreateRoleAsync ( "channel-boss" ) ;

// Assign users to roles (optional message)
await channelClient . AssignRolesAsync ( new AssignRoleRequest
{
    AssignRoles = new List < RoleAssignment >
    {
        new RoleAssignment { UserId = bob . ID , ChannelRole = Role . ChannelModerator } ,
        new RoleAssignment { UserId = june . ID , ChannelRole = "channel-boss" }
    } ,
    Message = new MessageRequest { Text = "Bob and June just became mods" , User = bob }
} ) ;

Устройства

 var deviceClient = clientFactory . GetDeviceClient ( ) ;

var junePhone = new Device
{
    ID = "iOS Device Token" ,
    PushProvider = PushProvider . APN ,
    UserId = june . ID
} ;

await deviceClient . AddDeviceAsync ( junePhone ) ;

var devices = await deviceClient . GetDevicesAsync ( june . Id ) ;

Экспортные каналы

 var channelClient = clientFactory . GetChannelClient ( ) ;
var taskClient = clientFactory . GetTaskClient ( ) ;

var taskResponse = channelClient . ExportChannelAsync ( new ExportChannelRequest { Id = channel . Id , Type = channel . Type } ) ;

// Wait for the completion
var complete = false ;
var iterations = 0 ;
AsyncTaskStatusResponse resp = null ;
while ( ! complete && iterations < 1000 )
{
    resp = await taskClient . GetTaskStatusAsync ( taskResponse . TaskId ) ;
    if ( resp . Status == AsyncTaskStatus . Completed )
    {
        complete = true ;
        break ;
    }
    iterations ++ ;
    await Task . Delay ( 100 ) ;
}

if ( complete )
{
    Console . WriteLine ( resp . Result [ "url" ] ) ;
} 

✍ Вклад

Мы приветствуем изменения кода, которые улучшают эту библиотеку или решают проблему, пожалуйста, следуйте всем лучшим практикам и добавляли тесты, если это применимо, прежде чем отправлять запрос на вытягивание на GitHub. Мы очень рады объединить ваш код в официальном репозитории. Обязательно подпишите наше лицензионное соглашение о лицензии (CLA). Смотрите наш файл лицензии для получения более подробной информации.

Отправляйтесь в Anplosing.md для некоторых советов по разработке.

? ‍ Мы нанимаем!

Недавно мы закрыли раунд финансирования серии B в размере 38 миллионов долларов, и мы продолжаем активно расти. Наши API используются более чем миллиардами конечных пользователей, и у вас будет возможность оказать огромное влияние на продукт в команде самых сильных инженеров по всему миру.

Ознакомьтесь с нашими текущими открытиями и примените через веб -сайт Stream.