https://github.com/sendbird/sendbird-chat-sample-android
https://github.com/sendbird/sendbird-chat-sample-android
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sendbird/sendbird-chat-sample-android
- Owner: sendbird
- License: mit
- Created: 2022-03-11T04:31:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T15:19:13.000Z (over 1 year ago)
- Last Synced: 2025-04-24T06:54:50.242Z (about 1 year ago)
- Language: Kotlin
- Homepage: https://sendbird.com/docs/chat/sdk/v4/android/overview
- Size: 11.1 MB
- Stars: 17
- Watchers: 16
- Forks: 15
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sendbird Chat sample for Android
## Overview
This repository provides feature-level Chat samples with Kotlin to demonstrate how to use the [Sendbird Chat SDK](https://sendbird.com/docs/chat).
## 🔒 Security tip
When a new Sendbird application is created in the dashboard the default security settings are set permissive to simplify running samples and implementing your first code.
Before launching make sure to review the security tab under ⚙️ Settings -> Security, and set Access token permission to Read Only or Disabled so that unauthenticated users can not login as someone else. And review the Access Control lists. Most apps will want to disable "Allow retrieving user list" as that could expose usage numbers and other information.
## Requirements
Android Studio 2.0+
## Running the app
Open this project in Android Studio and select 'run configurations' to view a dropdown of feature-level Chat samples to choose from.
Once a sample is chosen, create a device and run the app on an Android device or Android emulator.
### Language
+ Kotlin
### Version
+ Android SDK
+ compileSdk: 32
+ minSdk: 26
+ targetSdk: 32
+ Gradle Version
+ gradle: 7.2
+ android gradle plugin: 4.2.0
## Project structure
```
.
├── commonmodule
│ ├── ui
│ │ ├── CustomViews
│ │ └── base
│ │ ├── BaseApplication
│ │ ├── BaseActivity
│ │ └── BaseFragment
│ └── utils
│ ├── Utils
│ └── Extension
├── groupchannel-basic
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-typingindicator
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-readnessage
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-unreadmessages
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-onlinemembers
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-membersandoperators
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-banned-and-muted-users
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-groupchannel-add-remove-operators
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-mention-members
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-report-user-message-channel
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-freeze-unfreeze
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-mute-user
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-admin-message
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-ban-unban-user
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-mark-message-read
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-push-notifications
│ ├── groupchannel
│ ├── main
│ └── user
├── groupchannel-update-message-operator
│ ├── groupchannel
│ ├── main
│ └── user
├── openchannel-basic
│ ├── openchannel
│ └── main
├── openchannel-user-online
│ ├── openchannel
│ └── main
├── openchannel-update-message
│ ├── openchannel
│ └── main
├── openchannel-delete-message
│ ├── openchannel
│ └── main
├── openchannel-copy-message
│ ├── openchannel
│ └── main
├── openchannel-mention-user
│ ├── openchannel
│ └── main
├── openchannel-report-message-user-channel
│ ├── openchannel
│ └── main
├── openchannel-admin-message
│ ├── openchannel
│ └── main
└── openchannel-feature-a
...
```
### [CommonModule](https://github.com/sendbird/sendbird-chat-sample-android/tree/main/commonmodule)
- [ui](https://github.com/sendbird/sendbird-chat-sample-android/tree/main/commonmodule/src/main/java/com/sendbird/chat/module/ui)
- Created for frequently used views.
- Created activities commonly used such as Sign-Up, Splash, and UserInfo.
- [utils](https://github.com/sendbird/examples-chat-ios/tree/main/CommonModule/CommonModule/View)
- Commonly used functions in Basic, Feature App
### BasicSample
- groupchannel-basic
- openchannel-basic
### FeatureSample
- groupchannel-typingindicator
- groupchannel-unreadmessages
- groupchannel-readmessage
- groupchannel-onlinemembers
- groupchannel-membersandoperators
- groupchannel-banned-and-muted-users
- groupchannel-user-online
- groupchannel-mention-members
- openchannel-user-online
- openchannel-delete-message
- openchannel-update-message
- openchannel-copy-message
...
## Considerations in real world app
- In this sample repo users are connecting to sendbird using a user ID (Sendbird Dashboard --> Security --> Read & Write). Read & Write is not secure and will create a new user automatically from the SDK if none exists. In production be sure to change the Sendbird Dashboard security settings to Deny login, and [authenticate users](https://sendbird.com/docs/chat/v4/android/guides/authentication#2-connect-to-sendbird-server-with-a-user-id-and-a-token) with a Sendbird generated Session Token.