Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Accept a call'
description: 'OpenIM Android SDK guide for Accept a call.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/managing-calls/accept-call'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Cancel a call invitation'
description: 'OpenIM Android SDK guide for Cancel a call invitation.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/managing-calls/cancel-call'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Handle call events'
description: 'OpenIM Android SDK guide for Handle call events.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/managing-calls/handle-call-events'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'End a call'
description: 'OpenIM Android SDK guide for End a call.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/managing-calls/hang-up-call'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Reject a call'
description: 'OpenIM Android SDK guide for Reject a call.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/managing-calls/reject-call'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Start a group call'
description: 'OpenIM Android SDK guide for Start a group call.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/managing-calls/start-group-call'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Start a one-to-one call'
description: 'OpenIM Android SDK guide for Start a one-to-one call.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/managing-calls/start-single-call'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
17 changes: 17 additions & 0 deletions content/docs/chat/sdk/android/calling/overview-calling.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Audio and video calling overview'
description: 'OpenIM Android SDK guide for Audio and video calling overview.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/overview-calling'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Get a group call room'
description: 'OpenIM Android SDK guide for Get a group call room.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/retrieving-call-information/get-room-by-group-id'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Get a call room token'
description: 'OpenIM Android SDK guide for Get a call room token.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/retrieving-call-information/get-token-by-room-id'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Restore a pending call invitation'
description: 'OpenIM Android SDK guide for Restore a pending call invitation.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/retrieving-call-information/restore-pending-invitation'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Send a custom signal'
description: 'OpenIM Android SDK guide for Send a custom signal.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'draft'
lastUpdated: '2026-07-20'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/calling/sending-custom-signals/send-a-custom-signal'
generatedBy: 'sync-client-sdk-route-skeletons'
---

## Overview

The English version of this OpenIM Android SDK guide is deferred until the reviewed Chinese documentation is complete.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: 'Clear messages in a conversation'
description: 'Use messageManager.clearConversationAndDeleteAllMsg() to keep an Android conversation entry while clearing its messages.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'published'
lastUpdated: '2026-08-07'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/conversation/managing-conversations/clear-conversation-messages'
---

Use `messageManager.clearConversationAndDeleteAllMsg()` for a product action such as “clear chat history”.

```java
OpenIMClient.getInstance().messageManager.clearConversationAndDeleteAllMsg(
conversationID,
new OnBase<String>() {
@Override
public void onSuccess(String data) {
messageStore.clearConversation(conversationID);
}

@Override
public void onError(int code, String error) {
recordConversationClearFailure(code, error);
}
}
);
```

The conversation entry remains while the current account's messages and summary state are cleared. Clear the visible message list immediately, then reconcile the latest message, summary, and unread state from `onConversationChanged` or a fresh query.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: 'Reset group mention status'
description: 'Use resetConversationGroupAtType() to reset an Android conversation group mention state.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'published'
lastUpdated: '2026-08-07'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/conversation/managing-conversations/clear-group-mentions'
---

After handling group messages that mention the current user, call `resetConversationGroupAtType()` to reset `groupAtType` to the normal state.

```java
OpenIMClient.getInstance().conversationManager.resetConversationGroupAtType(
new OnBase<String>() {
@Override
public void onSuccess(String data) {
markGroupMentionStateReset(conversationID);
}

@Override
public void onError(int code, String error) {
recordGroupMentionResetFailure(code, error);
}
},
conversationID
);
```

This operation only resets the state and must not be used to set `atMe` or `atAll`. Group mention state is distinct from message read state. Reconcile the conversation through `onConversationChanged`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: 'Delete a conversation and its messages'
description: 'Use deleteConversationAndDeleteAllMsg() to delete an Android conversation and its messages.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'published'
lastUpdated: '2026-08-07'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/conversation/managing-conversations/delete-conversation-with-messages'
---

Use `deleteConversationAndDeleteAllMsg()` for a product action such as “delete this chat”.

```java
OpenIMClient.getInstance().conversationManager.deleteConversationAndDeleteAllMsg(
new OnBase<String>() {
@Override
public void onSuccess(String data) {
messageStore.clearConversation(conversationID);
conversationStore.remove(conversationID);
}

@Override
public void onError(int code, String error) {
recordConversationDeleteFailure(code, error);
}
},
conversationID
);
```

After success, clear the current message list and conversation row. This does not delete a friend relationship or leave or dismiss a group. A conversation can be regenerated by a new message or synchronization while the chat target still exists; reconcile through `onConversationChanged` or a fresh query.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: 'Track the total unread count'
description: 'Use getTotalUnreadMsgCount() to retrieve the total unread count for the current Android account.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'published'
lastUpdated: '2026-08-07'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/conversation/managing-conversations/get-total-unread-count'
---

`getTotalUnreadMsgCount()` returns the complete unread snapshot for the signed-in account. Do not sum `unreadCount` values from only the currently loaded conversation pages.

```java
OpenIMClient.getInstance().conversationManager.getTotalUnreadMsgCount(
new OnBase<String>() {
@Override
public void onSuccess(String value) {
int totalUnread = Integer.parseInt(value);
updateApplicationBadge(totalUnread);
}

@Override
public void onError(int code, String error) {
recordTotalUnreadFailure(code, error);
}
}
);
```

The callback value is a `String`; handle parse failures as an application error rather than treating it as a partial list total. This page owns `OnConversationListener.onTotalUnreadMessageCountChanged(int count)`, which updates the application badge after the initial query.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: 'Hide a conversation'
description: 'Use hideConversation() to hide a conversation entry from the current Android account.'
product: 'sdk'
context: 'chat/sdk/android'
template: 'guide'
status: 'published'
lastUpdated: '2026-08-07'
version: 'v4'
platform: 'android'
sourcePath: '/sdk/android/conversation/managing-conversations/hide-a-conversation'
---

`hideConversation()` hides only the current account's conversation entry. It does not delete a one-to-one relationship, leave a group, or affect another account.

```java
OpenIMClient.getInstance().conversationManager.hideConversation(
new OnBase<String>() {
@Override
public void onSuccess(String data) {
conversationStore.remove(conversationID);
}

@Override
public void onError(int code, String error) {
recordConversationHideFailure(code, error);
}
},
conversationID
);
```

A hidden conversation can appear again after a new message or resynchronization. Remove it optimistically after success, then merge later `onConversationChanged` events idempotently by `conversationID`.
Loading
Loading