sendbird chat sdk android
v4.21.1
Le SDK Sendbird Chat pour Android vous permet d'ajouter un chat en temps réel dans votre application client avec un minimum d'effort. Sendbird propose une solution de chat riche en fonctionnalités, évolutive et éprouvée, dont dépendent des sociétés comme Reddit, Hinge, PubG et Paytm.
Le SDK Chat fournit toutes les fonctionnalités nécessaires pour offrir une expérience de chat riche. Sa mise en œuvre commence par l'ajout d'une connexion utilisateur, la liste des canaux disponibles, la sélection ou la création d'un canal ouvert ou d'un canal de groupe, et la réception de messages et d'autres événements via les délégués d'événements de canal et le capacité à envoyer un message. Une fois cette fonctionnalité de base en place, félicitations, vous disposez désormais d’une application de chat !
Une fois que cela est en place, jetez un œil à toutes les autres fonctionnalités prises en charge par Sendbird et ajoutez ce qui fonctionne le mieux pour vos utilisateurs.
Découvrez-en plus sur Sendbird Chat pour Android dans la documentation. Si vous avez des commentaires, des questions ou des demandes de fonctionnalités, faites-le nous savoir dans la communauté Sendbird.
La configuration minimale requise pour le SDK Chat pour Android est :
Android 5.0 (API level 21) or higherJava 8 or higherAndroid Gradle plugin 3.4.2 or higherFirebase Cloud Messaging 19.0.1 or higherRemarque : le serveur Sendbird prend en charge Transport Layer Security (TLS) de la version 1.0 à 1.3. Par exemple, dans les régions de serveurs où TLS 1.3 n'est pas disponible, les versions inférieures, séquentiellement de 1.2 à 1.0, seront prises en charge pour une transmission sécurisée des données.
Le moyen le plus rapide de commencer consiste à utiliser l'un des exemples d'applications du dépôt d'exemples, à créer une application dans le tableau de bord Sendbird et à copier l' App ID dans l'exemple d'application et vous êtes prêt à partir.
Avant d'installer le SDK Sendbird Chat, vous devez créer une application Sendbird sur le tableau de bord Sendbird. Vous aurez besoin de l' App ID de votre application Sendbird lors de l'initialisation du SDK Chat.
Remarque : Chaque application Sendbird peut être intégrée à une seule application client. Au sein d'une même application, les utilisateurs peuvent communiquer entre eux sur toutes les plateformes, qu'ils soient sur des appareils mobiles ou sur le Web.
L'installation du SDK Chat est simple si vous êtes habitué à utiliser des bibliothèques ou des SDK externes. Tout d’abord, ajoutez le code suivant à votre fichier racine build.gradle :
allprojects {
repositories {
.. .
maven { url " https://repo.sendbird.com/public/maven " }
}
}Remarque : assurez-vous que le bloc de code ci-dessus n'est pas ajouté au fichier
build.gradlede votre module.
Si vous utilisez Gradle 6.8 ou version ultérieure, ajoutez ce qui suit à votre fichier settings.gradle :
dependencyResolutionManagement {
repositories {
maven { url " https://repo.sendbird.com/public/maven " }
}
} Ensuite, ajoutez la dépendance au fichier build.gradle de niveau supérieur du projet :
dependencies {
.. .
implementation ' com.sendbird.sdk:sendbird-chat:4.21.1 '
.. .
}TLS 1.3 est activé par défaut dans le SDK Sendbird pour Android. Pour le désactiver, veuillez inclure la configuration suivante dans la dépendance gradle :
Remarque : Le SDK Android SendBird dépend de la bibliothèque Conscrypt afin de prendre en charge TLS 1.3.
dependencies {
implementation ( ' com.sendbird.sdk:sendbird-chat:4.21.1 ' ) {
exclude group : ' org.conscrypt ' , module : ' conscrypt-android '
}
} Le SDK Chat nécessite des autorisations système, qui permettent la communication avec le serveur Sendbird ainsi que la lecture et l'écriture sur le stockage d'un appareil utilisateur. Pour accorder des autorisations système, ajoutez les lignes suivantes à votre fichier AndroidManifest.xml .
< uses-permission android : name = " android.permission.INTERNET " />
< uses-permission android : name = " android.permission.READ_EXTERNAL_STORAGE " />
< uses-permission android : name = " android.permission.WRITE_EXTERNAL_STORAGE " /> Lorsque vous créez votre APK avec minifyEnabled true , ajoutez la ligne suivante au fichier de règles ProGuard du module.
-dontwarn com.sendbird.android.shadow. ** Maintenant que le SDK Chat a été importé, nous sommes prêts à commencer à envoyer un message.
Afin d'utiliser les fonctionnalités du SDK Chat, une instance SendbirdChat doit être lancée via l'authentification de l'utilisateur avec le serveur Sendbird. Cette instance communique et interagit avec le serveur sur la base d'un compte utilisateur authentifié, puis l'application cliente de l'utilisateur peut utiliser les fonctionnalités du SDK Chat.
Voici les étapes à suivre pour envoyer votre premier message à l'aide du SDK Chat :
Maintenant, initialisez le SDK Chat dans l'application pour permettre au SDK Chat de répondre aux modifications de l'état de connexion dans les applications clientes Android.
Pour initialiser l'instance SendbirdChat , transmettez l' APP_ID de votre application Sendbird dans le tableau de bord Sendbird comme argument à un paramètre de la méthode SendbirdChat.init() . Comme SendbirdChat.init() ne peut être qu'une seule instance, appelez-la une seule fois dans votre application client Android. En règle générale, l'initialisation est implémentée dans l'écran de connexion de l'utilisateur.
Remarque : Il est recommandé d'initialiser le SDK Chat dans la méthode
onCreate()de l'instanceApplication.
SendbirdChat . init ( InitParams ( APP_ID , applicationContext, useCaching = true )) Après l'initialisation à l'aide de la méthode init() , votre application client doit toujours être connectée au serveur Sendbird avant d'appeler une méthode. Si vous tentez d'appeler une méthode sans vous connecter, une erreur ERR_CONNECTION_REQUIRED (800101) serait renvoyée.
Connectez un utilisateur au serveur Sendbird soit via un ID utilisateur unique, soit en combinaison avec un jeton d'accès. Sendbird préfère cette dernière méthode, car elle garantit la confidentialité de l'utilisateur. Le premier est utile pendant la phase de développement ou si votre service ne nécessite pas de sécurité supplémentaire.
Connectez un utilisateur au serveur Sendbird en utilisant son identifiant utilisateur unique. Par défaut, le serveur Sendbird peut authentifier un utilisateur par un identifiant utilisateur unique. Lors d'une demande de connexion, le serveur interroge la base de données pour vérifier une correspondance. Tout identifiant d'utilisateur non utilisé est automatiquement enregistré en tant que nouvel utilisateur dans le système Sendbird, tandis qu'un identifiant existant est autorisé à se connecter indirectement. L'identifiant doit être unique au sein d'une application Sendbird, comme une adresse e-mail hachée ou un numéro de téléphone dans votre service.
Cela vous permet d'être opérationnel sans avoir à approfondir les détails du processus d'enregistrement des jetons. Cependant, assurez-vous d'activer l'application des jetons avant le lancement, car le lancement sans risque constitue un risque de sécurité.
SendbirdChat .connect( USER_ID ) { user, e ->
if (e != null ) { // Error.
return @connect
}
} Sendbird préfère que vous transmettiez l'ID de l'APP via l'utilisation d'un jeton, car cela garantit la confidentialité et la sécurité des utilisateurs. Créez un utilisateur avec son jeton d'accès ou émettez un jeton de session à transmettre lors de la connexion. Une comparaison entre un jeton d'accès et un jeton de session peut être trouvée ici. Une fois qu'un jeton est émis, un utilisateur doit fournir le jeton émis dans la méthode SendbirdChat.connect() qui est utilisée pour se connecter.
SendbirdChat.connect() . SendbirdChat .connect( USER_ID , AUTH_TOKEN ) { user, e ->
if (e != null ) { // Error.
return @connect
}
}Créez un canal ouvert en utilisant les codes suivants. Les canaux ouverts sont ceux où tous les utilisateurs de votre application Sendbird peuvent facilement participer sans invitation.
OpenChannel .createChannel( OpenChannelCreateParams ()) { channel, e ->
if (e != null ) { // Error.
return @createChannel
}
} Remarque : Vous pouvez également créer une chaîne de groupe pour envoyer un message. Pour en savoir plus, consultez Créer une chaîne dans la page Chaîne de groupe.
Entrez sur le canal ouvert pour envoyer et recevoir des messages.
OpenChannel .getChannel( CHANNEL_URL ) { channel, e ->
if (e != null ) { // Error.
return @getChannel
}
channel?.enter { enterError ->
if (enterError != null ) { // Error.
return @enter
}
}
}Enfin, envoyez un message à la chaîne. Il existe trois types : un message utilisateur, qui est un texte brut, un message de fichier, qui est un fichier binaire, tel qu'une image ou un PDF, et un message administrateur, qui est un texte brut également envoyé via le tableau de bord ou la plateforme de chat. API.
openChannel.sendUserMessage( MESSAGE ) { message, e ->
if (e != null ) { // Error.
return @sendUserMessage
}
}La taille du SDK Chat est un facteur important à prendre en compte lors de son intégration dans votre application. La taille du SDK Chat est la suivante :
Chez Sendbird, nous sommes un groupe diversifié d'individus humbles, amicaux et travailleurs, unis par un objectif commun : créer la prochaine génération de technologies mobiles et sociales, à travers le chat, la voix et la vidéo, qui changent notre façon de travailler et de vivre. Nous sommes toujours à la recherche de personnes formidables pour rejoindre notre équipe. Consultez notre page carrières pour plus d’informations.
