stream chat net

SDK .NET oficial para chat de transmisión

Cliente oficial de API .NET para el chat de transmisión, un servicio para crear aplicaciones de chat.
Explore los documentos »

Muestras de código · Informe de error · Función de solicitud

Acerca de la transmisión

Puede registrarse para obtener una cuenta de transmisión en nuestra página de inicio.

Puede usar esta biblioteca para acceder al lado del servidor de puntos finales de API de chat.

Para las integraciones del lado del cliente (web y móvil), eche un vistazo a las bibliotecas JavaScript, iOS y Android SDK (DOCS).

---

Cambios de ruptura en v1.0 <

La biblioteca recibió muchos cambios en V1.0 para que sea más fácil de usar y más mantenible en el futuro. El cambio principal es que tanto las clases Channel como Client se han separado en pequeños módulos que llamamos clientes. (Esto también vuelve a alzar la estructura de nuestra biblioteca Java.) Cambios principales:

• Las clases Channel y Client se han ido, y se han organizado en clientes más pequeños en el espacio de nombres de StreamChat.Clients .
• Estos clientes no mantienen el estado como Channel solía hacer antes, donde mantenía channelType y channelId en la memoria. Esto significa que deberá pasar en channelType y channelId a muchas llamadas de método en IChannelClient .
• Los nombres de métodos async tienen sufijo Async ahora.
• Todos los métodos y clases públicos tienen documentación.
• Los identificadores han sido renombrados de ID a Id para seguir la guía de nombres de Microsoft. Como userID -> userId .
• Se han renombrado muchas clases de datos para tener más sentido. Como ChannelObject -> Channel .
• Las clases de datos se han movido al espacio de nombres StreamChat.Models .
• Paridad completa de funciones: todas las API de backend están disponibles.
• Los valores devueltos son el tipo de ApiResponse y Expose Tasa Limit Informaiton con el método GetRateLimit() .
• La estructura de la carpeta del proyecto se ha reorganizado para seguir la recomendación de Microsoft.
• Se han mejorado las pruebas unitarias. Son más pequeños, más centrados y tienen métodos de limpieza.
• Se agregó soporte .NET 6.0.

El uso adecuado de la biblioteca:

 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 ) ; 

---

Instalación

$ dotnet add package stream-chat-net

Consejo: puede encontrar muestras de código en la carpeta de muestras.

Empezando

Importar

 using StreamChat . Clients ;

Inicializar el cliente

 // 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 ( ) ;

Generar un token para el uso del lado del cliente

 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 ) ) ;

Crear/actualizar usuarios

 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 } ) ;

Puntos finales de usuario similares a 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" ) ;

Tipos de canales

 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 ( ) ;

Canales

 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 ) ;

Mensajería

 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 )

Reacciones

 var reactionClient = clientFactory . GetReactionClient ( ) ;

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

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

Moderación

 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 ) ;

Permisos

 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 }
} ) ;

Dispositivos

 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 ) ;

Canales de exportación

 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" ] ) ;
} 

✍️ contribuyendo

Agradecemos los cambios en el código que mejoran esta biblioteca o solucionamos un problema, asegúrese de seguir todas las mejores prácticas y agregar pruebas si corresponde antes de enviar una solicitud de extracción en GitHub. Estamos muy contentos de fusionar su código en el repositorio oficial. Asegúrese de firmar primero nuestro Acuerdo de Licencia de Contributor (CLA). Vea nuestro archivo de licencia para obtener más detalles.

Dirígete a contribuir. MD para algunos consejos de desarrollo.

? ‍ ¡Estamos contratando!

Recientemente cerramos una ronda de financiación Serie B de $ 38 millones y seguimos creciendo activamente. Nuestras API son utilizadas por más de mil millones de usuarios finales, y tendrá la oportunidad de tener un gran impacto en el producto dentro de un equipo de los ingenieros más fuertes de todo el mundo.

Consulte nuestras aperturas actuales y aplique a través del sitio web de Stream.