cc.openkit.kitChat.rongcloud.rong.methods

类 Message

java.lang.Object

cc.openkit.kitChat.rongcloud.rong.methods.Message

public class Message
extends java.lang.Object

构造器概要

构造器

构造器和说明
Message(java.lang.String appKey, java.lang.String appSecret)

方法概要

限定符和类型	方法和说明
CodeSuccessResult	broadcast(java.lang.String fromUserId, BaseMessage message, java.lang.String pushContent, java.lang.String pushData, java.lang.String os) 发送广播消息方法（发送消息给一个应用下的所有注册用户，如用户未在线会对满足条件（绑定手机终端）的用户发送 Push 信息，单条消息最大 128k，会话类型为 SYSTEM。
CodeSuccessResult	deleteMessage(java.lang.String date) 消息历史记录删除方法（删除 APP 内指定某天某小时内的所有会话消息记录。
HistoryMessageResult	getHistory(java.lang.String date) 消息历史记录下载地址获取 方法消息历史记录下载地址获取方法。
CodeSuccessResult	publishChatroom(java.lang.String fromUserId, java.lang.String[] toChatroomId, BaseMessage message) 发送聊天室消息方法（一个用户向聊天室发送消息，单条消息最大 128k。
CodeSuccessResult	publishDiscussion(java.lang.String fromUserId, java.lang.String toDiscussionId, BaseMessage message, java.lang.String pushContent, java.lang.String pushData, java.lang.Integer isPersisted, java.lang.Integer isCounted, java.lang.Integer isIncludeSender) 发送讨论组消息方法（以一个用户身份向讨论组发送消息，单条消息最大 128k，每秒钟最多发送 20 条消息.）
CodeSuccessResult	publishGroup(java.lang.String fromUserId, java.lang.String[] toGroupId, BaseMessage message, java.lang.String pushContent, java.lang.String pushData, java.lang.Integer isPersisted, java.lang.Integer isCounted, java.lang.Integer isIncludeSender) 发送群组消息方法（以一个用户身份向群组发送消息，单条消息最大 128k.每秒钟最多发送 20 条消息，每次最多向 3 个群组发送，如：一次向 3 个群组发送消息，示为 3 条消息。）
CodeSuccessResult	publishPrivate(java.lang.String fromUserId, java.lang.String[] toUserId, BaseMessage message, java.lang.String pushContent, java.lang.String pushData, java.lang.String count, java.lang.Integer verifyBlacklist, java.lang.Integer isPersisted, java.lang.Integer isCounted, java.lang.Integer isIncludeSender) 发送单聊消息方法（一个用户向另外一个用户发送消息，单条消息最大 128k。
CodeSuccessResult	PublishSystem(java.lang.String fromUserId, java.lang.String[] toUserId, BaseMessage message, java.lang.String pushContent, java.lang.String pushData, java.lang.Integer isPersisted, java.lang.Integer isCounted) 发送系统消息方法（一个用户向一个或多个用户发送系统消息，单条消息最大 128k，会话类型为 SYSTEM。
CodeSuccessResult	publishSystemTemplate(TemplateMessage templateMessage) 发送系统模板消息方法（一个用户向一个或多个用户发送系统消息，单条消息最大 128k，会话类型为 SYSTEM.每秒钟最多发送 100 条消息，每次最多同时向 100 人发送，如：一次发送 100 人时，示为 100 条消息。）
CodeSuccessResult	publishTemplate(TemplateMessage templateMessage) 发送单聊模板消息方法（一个用户向多个用户发送不同消息内容，单条消息最大 128k。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Message

public Message(java.lang.String appKey,
               java.lang.String appSecret)

方法详细资料

publishPrivate

public CodeSuccessResult publishPrivate(java.lang.String fromUserId,
                                        java.lang.String[] toUserId,
                                        BaseMessage message,
                                        java.lang.String pushContent,
                                        java.lang.String pushData,
                                        java.lang.String count,
                                        java.lang.Integer verifyBlacklist,
                                        java.lang.Integer isPersisted,
                                        java.lang.Integer isCounted,
                                        java.lang.Integer isIncludeSender)
                                 throws java.lang.Exception

发送单聊消息方法（一个用户向另外一个用户发送消息，单条消息最大 128k。每分钟最多发送 6000 条信息，每次发送用户上限为 1000 人，如：一次发送 1000 人时，示为 1000 条消息。）

参数:

fromUserId:发送人用户 - Id。（必传）

toUserId:接收用户 - Id，可以实现向多人发送消息，每次上限为 1000 人。（必传）

pushContent:定义显示的 - Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息。如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）

count:针对 - iOS 平台，Push 时用来控制未读消息显示数，只有在 toUserId 为一个用户 Id 的时候有效。（可选）

verifyBlacklist:是否过滤发送人黑名单列表，0 - 表示为不过滤、 1 表示为过滤，默认为 0 不过滤。（可选）

isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 - 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）

isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 - 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）

isIncludeSender:发送用户自已是否接收消息，0 - 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

publishTemplate

public CodeSuccessResult publishTemplate(TemplateMessage templateMessage)
                                  throws java.lang.Exception

发送单聊模板消息方法（一个用户向多个用户发送不同消息内容，单条消息最大 128k。每分钟最多发送 6000 条信息，每次发送用户上限为 1000 人。）

参数:

templateMessage:单聊模版消息。 -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

PublishSystem

public CodeSuccessResult PublishSystem(java.lang.String fromUserId,
                                       java.lang.String[] toUserId,
                                       BaseMessage message,
                                       java.lang.String pushContent,
                                       java.lang.String pushData,
                                       java.lang.Integer isPersisted,
                                       java.lang.Integer isCounted)
                                throws java.lang.Exception

发送系统消息方法（一个用户向一个或多个用户发送系统消息，单条消息最大 128k，会话类型为 SYSTEM。每秒钟最多发送 100 条消息，每次最多同时向 100 人发送，如：一次发送 100 人时，示为 100 条消息。）

参数:

fromUserId:发送人用户 - Id。（必传）

toUserId:接收用户 - Id，提供多个本参数可以实现向多人发送消息，上限为 1000 人。（必传）

pushContent:如果为自定义消息，定义显示的 - Push 内容，内容中定义标识通过 values 中设置的标识位内容进行替换.如消息类型为自定义不需要 Push 通知，则对应数组传空值即可。（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。如不需要 Push 功能对应数组传空值即可。（可选）

isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 - 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）

isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 - 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

publishSystemTemplate

public CodeSuccessResult publishSystemTemplate(TemplateMessage templateMessage)
                                        throws java.lang.Exception

发送系统模板消息方法（一个用户向一个或多个用户发送系统消息，单条消息最大 128k，会话类型为 SYSTEM.每秒钟最多发送 100 条消息，每次最多同时向 100 人发送，如：一次发送 100 人时，示为 100 条消息。）

参数:

templateMessage:系统模版消息。 -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

publishGroup

public CodeSuccessResult publishGroup(java.lang.String fromUserId,
                                      java.lang.String[] toGroupId,
                                      BaseMessage message,
                                      java.lang.String pushContent,
                                      java.lang.String pushData,
                                      java.lang.Integer isPersisted,
                                      java.lang.Integer isCounted,
                                      java.lang.Integer isIncludeSender)
                               throws java.lang.Exception

发送群组消息方法（以一个用户身份向群组发送消息，单条消息最大 128k.每秒钟最多发送 20 条消息，每次最多向 3 个群组发送，如：一次向 3 个群组发送消息，示为 3 条消息。）

参数:

fromUserId:发送人用户 - Id 。（必传）

toGroupId:接收群Id，提供多个本参数可以实现向多群发送消息，最多不超过 - 3 个群组。（必传）

pushContent:定义显示的 - Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息. 如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）

isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 - 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）

isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 - 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）

isIncludeSender:发送用户自已是否接收消息，0 - 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

publishDiscussion

public CodeSuccessResult publishDiscussion(java.lang.String fromUserId,
                                           java.lang.String toDiscussionId,
                                           BaseMessage message,
                                           java.lang.String pushContent,
                                           java.lang.String pushData,
                                           java.lang.Integer isPersisted,
                                           java.lang.Integer isCounted,
                                           java.lang.Integer isIncludeSender)
                                    throws java.lang.Exception

发送讨论组消息方法（以一个用户身份向讨论组发送消息，单条消息最大 128k，每秒钟最多发送 20 条消息.）

参数:

fromUserId:发送人用户 - Id。（必传）

toDiscussionId:接收讨论组 - Id。（必传）

pushContent:定义显示的 - Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息. 如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData.（可选）

isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 - 表示为不存储、 1 表示为存储，默认为 1 存储消息.（可选）

isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 - 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）

isIncludeSender:发送用户自已是否接收消息，0 - 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

publishChatroom

public CodeSuccessResult publishChatroom(java.lang.String fromUserId,
                                         java.lang.String[] toChatroomId,
                                         BaseMessage message)
                                  throws java.lang.Exception

发送聊天室消息方法（一个用户向聊天室发送消息，单条消息最大 128k。每秒钟限 100 次。）

参数:

fromUserId:发送人用户 - Id。（必传）

toChatroomId:接收聊天室Id，提供多个本参数可以实现向多个聊天室发送消息。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

broadcast

public CodeSuccessResult broadcast(java.lang.String fromUserId,
                                   BaseMessage message,
                                   java.lang.String pushContent,
                                   java.lang.String pushData,
                                   java.lang.String os)
                            throws java.lang.Exception

发送广播消息方法（发送消息给一个应用下的所有注册用户，如用户未在线会对满足条件（绑定手机终端）的用户发送 Push 信息，单条消息最大 128k，会话类型为 SYSTEM。每小时只能发送 1 次，每天最多发送 3 次。）

参数:

fromUserId:发送人用户 - Id。（必传）

pushContent:定义显示的 - Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息. 如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知.（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）

os:针对操作系统发送 - Push，值为 iOS 表示对 iOS 手机用户发送 Push ,为 Android 时表示对 Android 手机用户发送 Push ，如对所有用户发送 Push 信息，则不需要传 os 参数。（可选）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

getHistory

public HistoryMessageResult getHistory(java.lang.String date)
                                throws java.lang.Exception

消息历史记录下载地址获取 方法消息历史记录下载地址获取方法。获取 APP 内指定某天某小时内的所有会话消息记录的下载地址。（目前支持二人会话、讨论组、群组、聊天室、客服、系统通知消息历史记录下载）

参数:

date:指定北京时间某天某小时，格式为2014010101,表示：2014年1月1日凌晨1点。（必传） -

返回:

HistoryMessageResult

抛出:

java.lang.Exception

deleteMessage

public CodeSuccessResult deleteMessage(java.lang.String date)
                                throws java.lang.Exception

消息历史记录删除方法（删除 APP 内指定某天某小时内的所有会话消息记录。调用该接口返回成功后，date参数指定的某小时的消息记录文件将在随后的5-10分钟内被永久删除。）

参数:

date:指定北京时间某天某小时，格式为2014010101,表示：2014年1月1日凌晨1点。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception