ConversationConfig (release 5.1.3.3)

java.lang.Object
- io.rong.imkit.config.ConversationConfig

public class ConversationConfig
extends java.lang.Object

会话页面总配置项

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`enableMultiDeviceSync` 多端消息未读数同步，仅支持单群聊
`int`	`rc_chatroom_first_pull_message_count`
`boolean`	`rc_enable_automatic_download_voice_msg`
`boolean`	`rc_enable_mentioned_message`
`boolean`	`rc_enable_recall_message`
`boolean`	`rc_enable_resend_message`
`boolean`	`rc_enable_send_combine_message`
`int`	`rc_gifmsg_auto_download_size`
`boolean`	`rc_is_show_warning_notification`
`int`	`rc_max_message_selected_count`
`boolean`	`rc_media_selector_contain_video`
`int`	`rc_message_recall_edit_interval`
`int`	`rc_message_recall_interval`
`boolean`	`rc_play_audio_continuous`
`int`	`rc_read_receipt_request_interval`
`static java.lang.String`	`SP_NAME_READ_RECEIPT_CONFIG`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessageProvider(IMessageProvider provider)`
`void`	`addMoreClickAction(int index, IClickActions action)`
`void`	`addViewProcessor(IConversationUIRenderer processor)` ConversationFragment 处理器
`ConversationClickListener`	`getConversationClickListener()`
`int`	`getConversationHistoryMessageCount()`
`int`	`getConversationRemoteMessageCount()`
`int`	`getConversationShowUnreadMessageCount()`
`ProviderManager<UiMessage>`	`getMessageListProvider()`
`android.text.Spannable`	`getMessageSummary(android.content.Context context, MessageContent messageContent)` 获得消息展示信息
`java.util.List<IClickActions>`	`getMoreClickActions()` 获取会话页面长按消息，弹出框里点击"更多"选项时，底部需要显示的条目。可以通过对此列表的增删，进行自定义显示。
`OnSendMessageListener`	`getSendMessageLister()`
`IMessageViewModelProcessor`	`getViewModelProcessor()`
`java.util.List<IConversationUIRenderer>`	`getViewProcessors()`
`void`	`initConfig(android.content.Context context)`
`boolean`	`isEnableMultiDeviceSync(Conversation.ConversationType type)` 是否打开多端阅读状态同步功能。开启之后，在其它端阅读过的消息，当前客户端会同步清掉未读数。
`boolean`	`isShowHistoryDividerMessage()`
`boolean`	`isShowHistoryMessageBar(Conversation.ConversationType type)` 是否显示历史未读消息气泡，仅支持设置私聊，群组
`boolean`	`isShowMoreClickAction()`
`boolean`	`isShowNewMentionMessageBar(Conversation.ConversationType type)` 会话页面右上角的未读 @ 消息数提示，目前仅支持群聊
`boolean`	`isShowNewMessageBar(Conversation.ConversationType type)` 新消息是否显示未读气泡，目前仅支持单群聊
`boolean`	`isShowReadReceipt(Conversation.ConversationType type)` 仅适用单聊和加密
`boolean`	`isShowReadReceiptRequest(Conversation.ConversationType type)` 仅适用群聊和讨论组
`boolean`	`isShowReceiverUserTitle(Conversation.ConversationType type)` 单聊是否显示用户昵称仅支持配置单聊属性
`void`	`replaceMessageProvider(java.lang.Class oldProviderClass, IMessageProvider provider)` 替换已有的模板
`void`	`setConversationClickListener(ConversationClickListener conversationClickListener)`
`void`	`setConversationHistoryMessageCount(int conversationHistoryMessageCount)`
`void`	`setConversationRemoteMessageCount(int conversationRemoteMessageCount)`
`void`	`setConversationShowUnreadMessageCount(int conversationShowUnreadMessageCount)`
`void`	`setEnableMultiDeviceSync(boolean enableMultiDeviceSync)`
`void`	`setEnableReadReceipt(boolean enable)` 设置已读回执，仅支持单聊，群聊，讨论组，密聊，其余不生效
`void`	`setSendMessageListener(OnSendMessageListener listener)`
`void`	`setShowHistoryDividerMessage(boolean showHistoryDividerMessage)`
`void`	`setShowHistoryMessageBar(boolean showHistoryMessageBar)`
`void`	`setShowMoreClickAction(boolean showMoreClickAction)`
`void`	`setShowNewMentionMessageBar(boolean showNewMentionMessageBar)`
`void`	`setShowNewMessageBar(boolean showNewMessageBar)`
`void`	`setShowReceiverUserTitle(boolean showReceiverUserTitle)`
`void`	`setSupportReadReceiptConversationType(Conversation.ConversationType... types)`
`void`	`setViewModelProcessor(IMessageViewModelProcessor viewModelProcessor)`
`boolean`	`showSummaryWithName(MessageContent messageContent)` 是否在消息列表显示名称

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SP_NAME_READ_RECEIPT_CONFIG
```
public static java.lang.String SP_NAME_READ_RECEIPT_CONFIG
```
  - enableMultiDeviceSync
```
public static boolean enableMultiDeviceSync
```
    多端消息未读数同步，仅支持单群聊
  - rc_enable_recall_message
```
public boolean rc_enable_recall_message
```
  - rc_enable_resend_message
```
public boolean rc_enable_resend_message
```
  - rc_message_recall_interval
```
public int rc_message_recall_interval
```
  - rc_message_recall_edit_interval
```
public int rc_message_recall_edit_interval
```
  - rc_chatroom_first_pull_message_count
```
public int rc_chatroom_first_pull_message_count
```
  - rc_is_show_warning_notification
```
public boolean rc_is_show_warning_notification
```
  - rc_play_audio_continuous
```
public boolean rc_play_audio_continuous
```
  - rc_enable_mentioned_message
```
public boolean rc_enable_mentioned_message
```
  - rc_read_receipt_request_interval
```
public int rc_read_receipt_request_interval
```
  - rc_media_selector_contain_video
```
public boolean rc_media_selector_contain_video
```
  - rc_enable_automatic_download_voice_msg
```
public boolean rc_enable_automatic_download_voice_msg
```
  - rc_gifmsg_auto_download_size
```
public int rc_gifmsg_auto_download_size
```
  - rc_max_message_selected_count
```
public int rc_max_message_selected_count
```
  - rc_enable_send_combine_message
```
public boolean rc_enable_send_combine_message
```
- Method Detail
  - initConfig
```
public void initConfig(android.content.Context context)
```
  - addMoreClickAction
```
public void addMoreClickAction(int index,
                               IClickActions action)
```
    Parameters:
    
    index - 添加位置
    
    action - 添加点击更多事件
  - addViewProcessor
```
public void addViewProcessor(IConversationUIRenderer processor)
```
    ConversationFragment 处理器
    
    Parameters:
    
    processor -
  - getViewProcessors
```
public java.util.List<IConversationUIRenderer> getViewProcessors()
```
    Returns:
    
    ConversationFragment 处理器
  - addMessageProvider
```
public void addMessageProvider(IMessageProvider provider)
```
    Parameters:
    
    provider - 消息列表 item 提供者
  - replaceMessageProvider
```
public void replaceMessageProvider(java.lang.Class oldProviderClass,
                                   IMessageProvider provider)
```
    替换已有的模板
    
    Parameters:
    
    oldProviderClass - 旧模板 class 类
    
    provider - 新模板
  - getMessageListProvider
```
public ProviderManager<UiMessage> getMessageListProvider()
```
    Returns:
    
    获得消息模板列表
  - getMessageSummary
```
public android.text.Spannable getMessageSummary(android.content.Context context,
                                                MessageContent messageContent)
```
    获得消息展示信息
    
    Parameters:
    
    context - 上下文
    
    messageContent - 消息类型
    
    Returns:
  - showSummaryWithName
```
public boolean showSummaryWithName(MessageContent messageContent)
```
    是否在消息列表显示名称
    
    Parameters:
    
    messageContent - 消息类型
    
    Returns:
  - setShowReceiverUserTitle
```
public void setShowReceiverUserTitle(boolean showReceiverUserTitle)
```
    Parameters:
    
    showReceiverUserTitle - 单聊是否显示用户昵称
  - isShowReceiverUserTitle
```
public boolean isShowReceiverUserTitle(Conversation.ConversationType type)
```
    单聊是否显示用户昵称仅支持配置单聊属性
    
    Parameters:
    
    type - 会话类型
    
    Returns:
    
    是否显示
  - isShowMoreClickAction
```
public boolean isShowMoreClickAction()
```
    Returns:
    
    长按是否显示更多选项
  - setShowMoreClickAction
```
public void setShowMoreClickAction(boolean showMoreClickAction)
```
    Parameters:
    
    showMoreClickAction - 长按是否显示更多选项
  - isShowHistoryDividerMessage
```
public boolean isShowHistoryDividerMessage()
```
    Returns:
    
    是否显示历史消息模板
  - setShowHistoryDividerMessage
```
public void setShowHistoryDividerMessage(boolean showHistoryDividerMessage)
```
    Parameters:
    
    showHistoryDividerMessage - 是否显示历史消息模板
  - setShowNewMessageBar
```
public void setShowNewMessageBar(boolean showNewMessageBar)
```
    Parameters:
    
    showNewMessageBar - 新消息是否显示未读气泡，目前仅支持单群聊（聊天室等，设置无效）
  - isShowNewMessageBar
```
public boolean isShowNewMessageBar(Conversation.ConversationType type)
```
    新消息是否显示未读气泡，目前仅支持单群聊
    
    Parameters:
    
    type - 会话类型
    
    Returns:
    
    不支持类型返回false，支持类型返回 showHistoryMessageBar 值
  - isShowNewMentionMessageBar
```
public boolean isShowNewMentionMessageBar(Conversation.ConversationType type)
```
    会话页面右上角的未读 @ 消息数提示，目前仅支持群聊
    
    Parameters:
    
    type - 会话类型
    
    Returns:
    
    不支持类型返回 false，支持类型返回 showNewMentionMessageBar 值
  - setShowNewMentionMessageBar
```
public void setShowNewMentionMessageBar(boolean showNewMentionMessageBar)
```
    Parameters:
    
    showNewMentionMessageBar - 是否显示会话页面右上角的未读 @ 消息数提示，仅支持设置群组
  - getConversationHistoryMessageCount
```
public int getConversationHistoryMessageCount()
```
  - setConversationHistoryMessageCount
```
public void setConversationHistoryMessageCount(int conversationHistoryMessageCount)
```
  - getConversationRemoteMessageCount
```
public int getConversationRemoteMessageCount()
```
  - setConversationRemoteMessageCount
```
public void setConversationRemoteMessageCount(int conversationRemoteMessageCount)
```
  - getConversationShowUnreadMessageCount
```
public int getConversationShowUnreadMessageCount()
```
  - setConversationShowUnreadMessageCount
```
public void setConversationShowUnreadMessageCount(int conversationShowUnreadMessageCount)
```
  - setShowHistoryMessageBar
```
public void setShowHistoryMessageBar(boolean showHistoryMessageBar)
```
    Parameters:
    
    showHistoryMessageBar - 是否显示历史未读消息气泡，仅支持设置私聊，群组
  - isShowHistoryMessageBar
```
public boolean isShowHistoryMessageBar(Conversation.ConversationType type)
```
    是否显示历史未读消息气泡，仅支持设置私聊，群组
    
    Parameters:
    
    type - 会话类型
    
    Returns:
    
    不支持类型返回false，支持类型返回 showHistoryMessageBar 值
  - getConversationClickListener
```
public ConversationClickListener getConversationClickListener()
```
  - setConversationClickListener
```
public void setConversationClickListener(ConversationClickListener conversationClickListener)
```
  - getMoreClickActions
```
public java.util.List<IClickActions> getMoreClickActions()
```
    获取会话页面长按消息，弹出框里点击"更多"选项时，底部需要显示的条目。可以通过对此列表的增删，进行自定义显示。
    
    Returns:
    
    当前设置的点击"更多"时底部显示的条目列表。
  - getViewModelProcessor
```
public IMessageViewModelProcessor getViewModelProcessor()
```
  - setViewModelProcessor
```
public void setViewModelProcessor(IMessageViewModelProcessor viewModelProcessor)
```
  - setEnableReadReceipt
```
public void setEnableReadReceipt(boolean enable)
```
    设置已读回执，仅支持单聊，群聊，讨论组，密聊，其余不生效
    
    Parameters:
    
    enable - 回执开关
  - setSupportReadReceiptConversationType
```
public void setSupportReadReceiptConversationType(Conversation.ConversationType... types)
```
  - isShowReadReceipt
```
public boolean isShowReadReceipt(Conversation.ConversationType type)
```
    仅适用单聊和加密
    
    Parameters:
    
    type - 会话类型
    
    Returns:
    
    不支持类型返回 false, 支持类型 enableReadReceipt 值
  - isShowReadReceiptRequest
```
public boolean isShowReadReceiptRequest(Conversation.ConversationType type)
```
    仅适用群聊和讨论组
    
    Parameters:
    
    type - 会话类型
    
    Returns:
    
    不支持类型返回 false, 支持类型返回 enableReadReceipt 值
  - isEnableMultiDeviceSync
```
public boolean isEnableMultiDeviceSync(Conversation.ConversationType type)
```
    是否打开多端阅读状态同步功能。开启之后，在其它端阅读过的消息，当前客户端会同步清掉未读数。
    
    Parameters:
    
    type - 会话类型。该功能仅支持单聊、群聊。
    
    Returns:
    
    功能是否开启。
  - setEnableMultiDeviceSync
```
public void setEnableMultiDeviceSync(boolean enableMultiDeviceSync)
```
  - setSendMessageListener
```
public void setSendMessageListener(OnSendMessageListener listener)
```
  - getSendMessageLister
```
public OnSendMessageListener getSendMessageLister()
```

Class ConversationConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SP_NAME_READ_RECEIPT_CONFIG

enableMultiDeviceSync

rc_enable_recall_message

rc_enable_resend_message

rc_message_recall_interval

rc_message_recall_edit_interval

rc_chatroom_first_pull_message_count

rc_is_show_warning_notification

rc_play_audio_continuous

rc_enable_mentioned_message

rc_read_receipt_request_interval

rc_media_selector_contain_video

rc_enable_automatic_download_voice_msg

rc_gifmsg_auto_download_size

rc_max_message_selected_count

rc_enable_send_combine_message

Method Detail

initConfig

addMoreClickAction

addViewProcessor

getViewProcessors

addMessageProvider

replaceMessageProvider

getMessageListProvider

getMessageSummary

showSummaryWithName

setShowReceiverUserTitle

isShowReceiverUserTitle

isShowMoreClickAction

setShowMoreClickAction

isShowHistoryDividerMessage

setShowHistoryDividerMessage

setShowNewMessageBar

isShowNewMessageBar

isShowNewMentionMessageBar

setShowNewMentionMessageBar

getConversationHistoryMessageCount

setConversationHistoryMessageCount

getConversationRemoteMessageCount

setConversationRemoteMessageCount

getConversationShowUnreadMessageCount

setConversationShowUnreadMessageCount

setShowHistoryMessageBar

isShowHistoryMessageBar

getConversationClickListener

setConversationClickListener

getMoreClickActions

getViewModelProcessor

setViewModelProcessor

setEnableReadReceipt

setSupportReadReceiptConversationType

isShowReadReceipt

isShowReadReceiptRequest

isEnableMultiDeviceSync

setEnableMultiDeviceSync

setSendMessageListener

getSendMessageLister