MirrorFly Chat Android SDK

https://www.mirrorfly.com/docs/chat/android/v3/
Admin
MirrorFly Chat Android SDK is a comprehensive messaging and chat library that enables real-time...
Tokens:52,669
Snippets:383
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Start Chat Backup in Android

Source: https://www.mirrorfly.com/docs/chat/android/v3/backup-and-restore

Initiates a backup of all chat messages to a file. It requires a BackupListener to track progress and an encryption flag to determine if the output file should be encrypted.

```Java
BackupManager.startBackup(new BackupListener() {
	@Override
	public void onProgressChanged(int percentage) {
	}
	@Override
	public void onSuccess(@NonNull String backUpFilePath) {
	}
	@Override
	public void onFailure(@NonNull String reason) {
	}
}, isEncrypt);
```

```Kotlin
BackupManager.startBackup(object : BackupListener{
	override fun onProgressChanged(percentage: Int) {
	}
	override fun onSuccess(backUpFilePath: String) {
	}
	override fun onFailure(reason: String) {
	}
}, isEncrypt)
```

--------------------------------

### Initialize MirrorFly Chat SDK (Kotlin)

Source: https://www.mirrorfly.com/docs/chat/android/v3/quick-start

Initialize the MirrorFly Chat SDK within your Application class's onCreate() method using the provided license key. This setup is crucial before utilizing any SDK features.

```kotlin
ChatManager.initializeSDK("LICENSE_KEY") { isSuccess, _, data ->
if (isSuccess) {
Log.d("TAG", "initializeSDK success ")
} else {
Log.d("TAG", "initializeSDK failed with error message"+ data["message"])
}
}
```

--------------------------------

### Initialize MirrorFly Chat SDK (Java)

Source: https://www.mirrorfly.com/docs/chat/android/v3/quick-start

Initialize the MirrorFly Chat SDK within your Application class's onCreate() method using the provided license key. This setup is crucial before utilizing any SDK features.

```java
ChatManager.initializeSDK("LICENSE_KEY", (isSuccess, throwable, data) -> {
if(isSuccess){
Log.d("TAG", "initializeSDK success ");
}else{
Log.d("TAG", "initializeSDK failed with reason "+data.get("message"));
}
});
```

--------------------------------

### Initialize Fetch Message List Parameters (Java & Kotlin)

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-messages

Creates and configures parameters for fetching a list of messages. Allows setting filters for chat JID, starting message ID/time, order, and limit. Optional parameters include metadata and topic ID.

```java
FetchMessageListParams messageListParams = new FetchMessageListParams();
messageListParams.setChatJid(JID);
messageListParams.setMessageId(MESSAGE_ID);
messageListParams.setMessageTime(MESSAGE_TIME);
messageListParams.setInclusive(true);
messageListParams.setAscendingOrder(true);
messageListParams.setLimit(50);
messageListParams.setMetaData(META_DATA);//Optional
messageListParams.setTopicId(TOPIC_ID); //Optional

```

```kotlin
val messageListParams = FetchMessageListParams().apply {
chatJid = JID
messageId = MESSAGE_ID
messageTime = MESSAGE_TIME
inclusive = true
ascendingOrder = true
limit = 50
metaData = META_DATA //Optional
topicId = TOPIC_ID// optional
}

```

--------------------------------

### Get Topics

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieves details for a list of topic IDs. The response includes topic data upon success or an error if fetching fails.

```java
ChatManager.getTopics(TOPIC_IDS, (isSuccess, throwable, data) -> {
if (isSuccess) {
Object result = ((JSONObject) data.get("data")).get("topics");
//handle success
} else {
// print throwable to find the exception details.
}
});
```

```kotlin
ChatManager.getTopics(TOPIC_IDS) { isSuccess, throwable, data ->
if (isSuccess) {
val result = (data["data"] as JSONObject).get("topics")
//handle success
} else {
// print throwable to find the exception details.
}
}
```

--------------------------------

### Get List of Created Chat Tags in Android (Java/Kotlin)

Source: https://www.mirrorfly.com/docs/chat/android/v3/chat-tags

Retrieves a list of created chat tags. It accepts a FlyCallback and a boolean to specify if the data should be fetched from the recent chat page. The callback handles the success status, exceptions, and returned data.

```java
ChatManager.getChatTagdata((isSuccess, throwable, data) -> {
}, isgetFromRecentChatPage);

```

```kotlin
ChatManager.getChatTagdata({ isSuccess, throwable, data ->
}, isgetFromRecentChatPage)

```

--------------------------------

### Declare Media Permissions for Android 13+ (AndroidManifest.xml)

Source: https://www.mirrorfly.com/docs/chat/android/v3/android-permissions

Starting from Android 13, specific permissions are needed to access different types of media files. Declare these in your AndroidManifest.xml for selecting images, audio, and video.

```xml
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_MEDIA_AUDIO" />
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />
```

--------------------------------

### GET /archive/settings/status

Source: https://www.mirrorfly.com/docs/chat/android/v3/archive-or-unarchive

Retrieves the current status of the archive settings.

```APIDOC
## GET /archive/settings/status

### Description
Checks whether the archive settings are currently enabled or disabled.

### Method
GET

### Response
#### Success Response (200)
- **status** (Boolean) - Returns True if enabled, False otherwise.

### Response Example
FlyCore.isArchivedSettingsEnabled();
```

--------------------------------

### Web Login and Media Configuration

Source: https://www.mirrorfly.com/docs/chat/android/v3/class-documentation

Models for web session management and media compression quality settings.

```APIDOC
## WebLogin Class

### Description
Holds parameters for QR code logged-in session details.

### Parameters
- **id** (Long) - ID of the web login detail
- **qrUniqeToken** (String) - Unique socket ID of the web session
- **webBrowserName** (String) - Browser name used for the session
- **osName** (String) - OS name or version
- **lastLoginTime** (String) - Timestamp of the last login

---

## MediaCompressQuality Class

### Description
Defines compression quality levels for media files.

### Properties
- **MediaCompressQuality.low** - Low quality compression
- **MediaCompressQuality.medium** - Medium quality compression
- **MediaCompressQuality.high** - High quality compression
- **MediaCompressQuality.uncompressed** - No compression applied
```

--------------------------------

### Get User MetaData

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieves the metadata associated with the current user.

```Java
ChatManager.getMetaData((isSuccess, throwable, data) -> {
	if (isSuccess) {
		ArrayList<MetaData> metDataList = (ArrayList<MetaData>) data.get("data");
	} else {
		// Fetching metaData failed
	}
});
```

```Kotlin
ChatManager.getMetaData() { isSuccess, throwable, data ->
	if (isSuccess) {
		val metaDataList :ArrayList<MetaData> = data.getData() as ArrayList<MetaData>
	} else {
		// Fetching metaData failed
	}
}
```

--------------------------------

### BackupManager.startBackup

Source: https://www.mirrorfly.com/docs/chat/android/v3/backup-and-restore

Initiates the chat backup process, allowing for optional encryption of the backup file.

```APIDOC
## POST BackupManager.startBackup

### Description
Starts the backup process for all chat messages and writes them to a file. The progress and result are handled via a listener.

### Method
SDK Method

### Parameters
#### Arguments
- **BACKUP_LISTENER** (BackupListener) - Required - Listener to observe backup events (onProgressChanged, onSuccess, onFailure).
- **isEncrypt** (boolean) - Required - Specifies whether the backup data should be encrypted.

### Request Example
BackupManager.startBackup(listener, true);

### Response
#### Success Response
- **backUpFilePath** (String) - The file path of the completed backup.
```

--------------------------------

### GET /chats/archived

Source: https://www.mirrorfly.com/docs/chat/android/v3/archive-or-unarchive

Retrieves the list of all archived recent chat conversations.

```APIDOC
## GET /chats/archived

### Description
Fetches the list of archived chats. Note: Call FlyCore.getArchivedChatsFromServer() first to sync data.

### Method
GET

### Response
#### Success Response (200)
- **data** (ArrayList<RecentChat>) - List of archived chat objects.

### Response Example
FlyCore.getArchivedChatList((isSuccess, throwable, data) -> {
  if (isSuccess) {
    ArrayList<RecentChat> result = (ArrayList<RecentChat>) data.get("data");
  }
});
```

--------------------------------

### Configure SDK Credentials in Gradle

Source: https://www.mirrorfly.com/docs/chat/android/v3/initialization

Define necessary SDK environment variables and credentials within the app's build.gradle file to ensure the SDK can authenticate and connect to the MirrorFly servers.

```Groovy
buildTypes {
	debug {
		buildConfigField 'String', 'SDK_BASE_URL', '"https://api-preprod-sandbox.mirrorfly.com/api/v1/"'
		buildConfigField 'String', 'XMPP_PORT', '"5222"'
		buildConfigField 'String', 'XMPP_DOMAIN', '"xmpp-preprod-sandbox.mirrorfly.com"'
		buildConfigField 'String', 'XMPP_HOST', '"xmpp-preprod-sandbox.mirrorfly.com"'
		buildConfigField 'String', 'IV_KEY', '"ddc0f15cc2c90fca"'
		buildConfigField 'String', 'LICENSE', '"xxxxxxxxxxxxxxxxxxxxxxxxx"'
		buildConfigField 'String', 'SIGNAL_SERVER', '"https://signal-preprod-sandbox.mirrorfly.com"'
		buildConfigField 'String', 'WEB_CHAT_LOGIN', '"https://webchat-preprod-sandbox.mirrorfly.com/"'
		buildConfigField 'String', 'JANUS_WEB_SOCKET_SERVER', '"wss://janus.mirrorfly.com"'
		buildConfigField "String", "SUPPORT_MAIL", '"abc_support@gmail.com"'
	}
}
```

--------------------------------

### GET /archived-chats

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieves the list of archived chat conversations and synchronizes them from the server.

```APIDOC
## GET /archived-chats

### Description
Fetches the list of chats that have been archived. Archived chats are excluded from the recent chat list.

### Method
GET

### Endpoint
FlyCore.getArchivedChatList(callback)

### Parameters
#### Path Parameters
- **CALLBACK** (FlyCallback) - Required - Lambda expression to handle the success or failure of the retrieval.

### Response
#### Success Response (200)
- **data** (ArrayList<RecentChat>) - List of archived chat objects.

### Response Example
{
  "data": [{"jid": "user1@domain.com", "lastMessage": "Hello"}]
}
```

--------------------------------

### Initialize and Connect to Chat Server

Source: https://www.mirrorfly.com/docs/chat/android/v3/initialization

Initializes connection parameters for the XMPP server and establishes the initial connection. Subsequent connections are managed automatically by the SDK.

```Java
ChatConnectionManager.initialize(USERNAME, SECRET_KEY, XMPP_DOMAIN, XMPP_HOST, XMPP_PORT);
ChatManager.makeXMPPConnection();
```

```Kotlin
ChatConnectionManager.initialize(USERNAME, SECRET_KEY, XMPP_DOMAIN, XMPP_HOST, XMPP_PORT)
ChatManager.makeXMPPConnection()
```

--------------------------------

### Initialize ChatSDK and Group Configuration

Source: https://www.mirrorfly.com/docs/chat/android/v3/initialization

Initialize the ChatSDK within the Application class using the Builder pattern. This includes setting up group configurations, license keys, and media storage paths.

```Java
GroupConfig groupConfiguration = new GroupConfig.Builder()
.enableGroupCreation(true)
.setMaximumMembersInAGroup(250)
.onlyAdminCanAddOrRemoveMembers(true)
.build();

ChatSDK.Builder()
.useProfileName(true)
.setDomainBaseUrl(BuildConfig.SDK_BASE_URL)
.enableMobileNumberLogin(true)
.setLicenseKey(BuildConfig.LICENSE)
.setIsTrialLicenceKey(true)
.setGroupConfiguration(groupConfiguration)
.setMediaFolderName(SELECT_YOUR_PATH_NAME)
.setIVKey(BuildConfig.IV_KEY)
.build();
```

```Kotlin
val groupConfiguration = GroupConfig.Builder()
.enableGroupCreation(true)
.setMaximumMembersInAGroup(250)
.onlyAdminCanAddOrRemoveMembers(true)
.build()

ChatSDK.Builder()
.useProfileName(true)
.setDomainBaseUrl(BuildConfig.SDK_BASE_URL)
.enableMobileNumberLogin(true)
.setLicenseKey(BuildConfig.LICENSE)
.setIsTrialLicenceKey(true)
.setGroupConfiguration(groupConfiguration)
.setMediaFolderName(SELECT_YOUR_PATH_NAME)
.setIVKey(BuildConfig.IV_KEY)
.build()
```

--------------------------------

### GET /ChatManager/getMessageActions

Source: https://www.mirrorfly.com/docs/chat/android/v3/managing-a-message

Retrieves the available actions for a specific list of messages.

```APIDOC
## GET /ChatManager/getMessageActions

### Description
Fetches available actions for a list of message IDs.

### Method
GET

### Parameters
#### Query Parameters
- **MESSAGE_ID_LIST** (List<String>) - Required - List of message IDs

### Response Example
{
  "availableMessageActions": ["reply", "forward", "delete"]
}
```

--------------------------------

### GET /search-conversation

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Searches for specific messages within a single chat, group, or across all conversations.

```APIDOC
## GET /search-conversation

### Description
Finds messages matching a search term. Supports scoped search by JID or global search.

### Method
GET

### Endpoint
FlyCore.searchConversation(SEARCH_TERM, JID, GLOBAL_SEARCH, CALLBACK)

### Parameters
#### Query Parameters
- **SEARCH_TERM** (String) - Required - The text characters to search for.
- **JID** (String) - Optional - Unique identifier of a contact/Group (empty for global search).
- **GLOBAL_SEARCH** (boolean) - Required - If true, searches across all conversations.

### Response
#### Success Response (200)
- **data** (ArrayList<ChatMessage>) - List of matching messages.

### Response Example
{
  "data": [{"messageId": "msg_123", "text": "Hello world"}]
}
```

--------------------------------

### Register User with FlyCore

Source: https://www.mirrorfly.com/docs/chat/android/v3/initialization

Registers a new user using a unique identifier and FCM token. The callback returns success status, potential errors, and registration data.

```Java
FlyCore.registerUser(USER_IDENTIFIER, FCM_TOKEN, (isSuccess, throwable, data) -> {
	if(isSuccess) {
		JSONObject responseObject = (JSONObject) data.get("data");
	} else {
		// Handle failure
	}
});
```

```Kotlin
FlyCore.registerUser(USER_IDENTIFIER, FCM_TOKEN) { isSuccess, throwable, data ->
	if(isSuccess) {
		val responseObject = data.get("data") as JSONObject
	} else {
		// Handle failure
	}
}
```

--------------------------------

### Get Recalled Messages

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-messages

Retrieve a list of recalled messages for a specific user or group using their JID.

```APIDOC
## Get Recalled Messages

### Description
To get the recalled messages of a user/group call the below method.

### Method
Not specified (likely a SDK method call)

### Endpoint
N/A (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
List<ChatMessage> recalledMessages = FlyMessenger.getRecalledMessagesOfAConversation(JID);
```
```kotlin
val recalledMessages : List<ChatMessage> = FlyMessenger.getRecalledMessagesOfAConversation(JID)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
#### Path Parameters

```

--------------------------------

### Get Recent Chat Pinned Count

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieve the total count of pinned chats in the recent chat list.

```APIDOC
## Recent Chat Pinned Count

### Description
To get the pinned count on the recent chat list, call the `recentChatPinnedCount` method.

### Method
GET

### Endpoint
`/chat/recent/pinned/count`

### Response
#### Success Response (200)
- **pinnedCount** (`int`) - The number of pinned chats.

### Response Example
```java
int pinnedCount = FlyCore.recentChatPinnedCount();
```
```kotlin
val pinnedCount : Int = FlyCore.recentChatPinnedCount()
```
```

--------------------------------

### Get Recent Chat List Including Archived

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieve the list of all recent chats, including archived conversations.

```APIDOC
## Get Recent Chat list with archived chats

### Description
To get the recent chat list including the archived chat conversations, call the `getRecentChatListIncludingArchived` method.

### Method
GET

### Endpoint
`/chat/recent/all`

### Response
#### Success Response (200)
- **recentChatList** (`ArrayList<RecentChat>`) - A list of all recent chats, including archived ones.

### Response Example
```java
ArrayList<RecentChat> recentChatList = FlyCore.getRecentChatListIncludingArchived();
```
```kotlin
val recentChatList : ArrayList<RecentChat> = FlyCore.getRecentChatListIncludingArchived()
```
```

--------------------------------

### Specify Custom Application Class in AndroidManifest

Source: https://www.mirrorfly.com/docs/chat/android/v3/quick-start

Reference your custom Application class (e.g., MyApplication) in the AndroidManifest.xml file. This ensures your application uses the custom class for initialization and other application-level logic.

```xml
<application
android:name=".MyApplication" // Add this line.
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:theme="@style/AppTheme">
<activity android:name=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
...
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
```

--------------------------------

### Set User Profile Information

Source: https://www.mirrorfly.com/docs/chat/android/v3/initialization

Update the user's profile name and country ISO code. This is required for proper identification and mobile number login functionality.

```Java
ChatManager.setUserCountryISOCode("IN");
ChatManager.setUserProfileName("John Wick");
```

```Kotlin
ChatManager.setUserCountryISOCode("IN")
ChatManager.setUserProfileName("John Wick")
```

--------------------------------

### Get Recent Chat List Including Archived

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieves the full list of recent chats, including those that have been archived.

```Java
ArrayList<RecentChat> recentChatList = FlyCore.getRecentChatListIncludingArchived();
```

```Kotlin
val recentChatList : ArrayList<RecentChat> = FlyCore.getRecentChatListIncludingArchived()
```

--------------------------------

### Get Multiple Messages by IDs

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-messages

Retrieves a list of ChatMessage objects corresponding to a provided list of message IDs.

```Java
List<ChatMessage> messages = FlyMessenger.getMessagesUsingIds(MESSAGE_ID_LIST);
```

```Kotlin
val messages : List<ChatMessage> = FlyMessenger.getMessagesUsingIds(MESSAGE_ID_LIST)
```

--------------------------------

### Get Recent Chat Pinned Count

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Returns the total number of chats currently pinned in the recent chat list.

```Java
int pinnedCount = FlyCore.recentChatPinnedCount();
```

```Kotlin
val pinnedCount : Int = FlyCore.recentChatPinnedCount()
```

--------------------------------

### Receive One-to-One Messages in Java and Kotlin

Source: https://www.mirrorfly.com/docs/chat/android/v3/quick-start

This section explains how to set up an observer to receive incoming one-to-one messages. The `MessageEventsListener` interface is used, and the `onMessageReceived` method is called whenever a new message arrives.

```java
ChatEventsManager.setupMessageEventListener(new MessageEventsListener() {
    @Override
    public void onMessageReceived(@NotNull ChatMessage message) {
        //called when the new message is received
    }
});
```

```kotlin
ChatEventsManager.setupMessageEventListener(object : MessageEventsListener {
    override fun onMessageReceived(message: ChatMessage) {
        //called when the new message is received
    }
})
```

--------------------------------

### Get Unread Message Count

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieve the total count of unread messages across all chats using the `getUnreadMessagesCount` method.

```Java
int unreadMessageCount = FlyMessenger.getUnreadMessagesCount();
```

```Kotlin
val unreadMessageCount : Integer = FlyMessenger.getUnreadMessagesCount()
```

--------------------------------

### Initialize Chat SDK in Application Class

Source: https://www.mirrorfly.com/docs/chat/android/v3/initialization

Configures the ChatManager and debug logging within the Android Application onCreate method. Requires a valid base URL with protocol and trailing slash.

```Java
@Override
public void onCreate() {
	super.onCreate();
	ChatManager.setStartActivity(MainActivity.class);
	LogMessage.enableDebugLogging(BuildConfig.DEBUG);
}
```

```Kotlin
override fun onCreate() {
	super.onCreate()
	ChatManager.startActivity = MainActivity::class.java
	LogMessage.enableDebugLogging(BuildConfig.DEBUG)
}
```

--------------------------------

### Get Single Message by ID

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-messages

Fetches a specific message object from the local database using its unique message ID.

```Java
ChatMessage message = FlyMessenger.getMessageOfId(MESSAGE_ID);
```

```Kotlin
val message : ChatMessage? = FlyMessenger.getMessageOfId(MESSAGE_ID)
```

--------------------------------

### Set Up Message Event Listener in Kotlin - MirrorFly Chat

Source: https://www.mirrorfly.com/docs/chat/android/v3/callback-listeners

This Kotlin code snippet demonstrates how to set up a message event listener using `ChatEventsManager.setupMessageEventListener`. It allows handling various chat events like message received, status updates, edits, media progress, and notifications. Note that setting multiple listeners will overwrite previous ones.

```kotlin
ChatEventsManager.setupMessageEventListener(object : MessageEventsListener {
override fun onMessageReceived(message: ChatMessage) {
//called when the new message is received
}
override fun onMessageStatusUpdated(messageId: String) {
//called when the message status is updated
//find the index of message object in list using messageId
//then fetch message object from db using `FlyMessenger.getMessageOfId(messageId)` and notify the item in list
}
override fun onMessageEdited(message: ChatMessage) {
//called when the message is edited
//find the index of message object in list using messageId
//then fetch message object from db using `FlyMessenger.getMessageOfId(messageId)` and notify the item in list
}
override fun onMediaStatusUpdated(message: ChatMessage) {
//called when the media message status is updated like downloaded,uploaded,failed
//find the index of message object in list using messageId
//then fetch message object from db using `FlyMessenger.getMessageOfId(messageId)` and notify the item in list
}
override fun onUploadDownloadProgressChanged(messageId: String, progressPercentage: Int) {
//called when the media message progress is updated
}
override fun onMessagesClearedOrDeleted(messageIds: ArrayList<String>, jid: String) {
//called when the message is deleted
}
override fun showOrUpdateOrCancelNotification(jid: String, chatMessage: ChatMessage?) {
//Called whenever a notification needed to be shown or updated or cancelled
}
override fun updateArchiveUnArchiveChats(toUser: String?, archiveStatus: Boolean) {
// Called whenever archive chats updated
}
override fun updateArchivedSettings(archivedSettingsStatus: Boolean) {
// Called whenever unarchive chats updated
}
override fun updateGroupReplyNotificationForArchivedSettingsEnabled(chatMessage: ChatMessage) {
// Code will added on Overridden Place
}
override fun onUpdateBusyStatus(status: Boolean, message: String?) {
// Called whenever busy status updated
}
override fun onChatCleared( toJid: String, chatClearType: ChatClearType) {
// Called when the chat is cleared or chat is deleted.
}
override fun onMessageDeleted(toJid: String, messageIds: ArrayList<String>, messageDeleteType: MessageDeleteType) {
//Called when the message is deleted for me or deleted for everyone by the current user or end user.
}
})
```

--------------------------------

### Get Chats By TopicId

Source: https://www.mirrorfly.com/docs/chat/android/v3/feature-common

Retrieves a list of chats associated with a specific topic ID. This method requires sending a request to the server.

--------------------------------

### Configure Gradle Repositories for MirrorFly SDK

Source: https://www.mirrorfly.com/docs/chat/android/v3/quick-start

Add MirrorFly's Maven repository to your project's Gradle configuration. This allows Gradle to download the SDK dependencies. Ensure you use the correct configuration based on your Gradle version.

```gradle
dependencyResolutionManagement {
repositories {
mavenCentral()
google()
jcenter()
maven {
url "https://repo.mirrorfly.com/release"
}
}
}
```

```gradle
allprojects {
repositories {
mavenCentral()
google()
jcenter()
maven {
url "https://repo.mirrorfly.com/release"
}
}
}
```
Tokens:
Raw