<IEMStatisticsManager>协议 参考

#import <IEMStatisticsManager.h>

类 <IEMStatisticsManager> 继承关系图:

构造函数
(EMChatMessageStatistics *_Nullable)	- getMessageStatisticsById:
(NSInteger)	- getMessageCountWithStart:end:direction:type:
(NSInteger)	- getMessageStatisticsSizeWithStart:end:direction:type:

详细描述

流量统计相关操作代理协议。

该协议中的方法可用于统计一定时间段内发送和/接收的指定类型的本地消息数量及其流量。

本地消息的流量统计功能默认关闭。若要使用该功能，需在 SDK 初始化前设置 EMOptions#enableStatistics 开启。

SDK 只支持统计该功能开启后最近 30 天内发送和接收的消息。各类消息的流量计算方法如下：

• 对于文本、透传、位置和自定义消息，消息流量为消息体的流量；
• 对于图片和视频消息，消息流量为消息体、图片或视频文件以及缩略图的流量之和；
• 对于文件和语音消息，消息流量为消息体和附件的流量。

注解

1. 对于携带附件的消息，下载成功后 SDK 才统计附件的流量。若附件下载多次，则会对下载的流量进行累加。
2. 对于从服务器拉取的漫游消息，如果本地数据库中已经存在，则不进行统计。

SDK 仅统计本地消息的流量，而非消息的实际流量。一般而言，该统计数据小于实际流量，原因如下：

• 未考虑发送消息时通用协议数据的流量；
• 对于接收到的消息，服务端会进行消息聚合，添加通用字段，而消息流量统计为各消息的流量，未考虑通用字段的流量消耗。

函数文档

getMessageCountWithStart:end:direction:type:

- (NSInteger) getMessageCountWithStart: (NSInteger)  startTimestamp end: (NSInteger)  endTimestamp direction: (EMMessageStatisticsDirection)  direction type: (EMMessageStatisticsType)  type

required

获取一定时间段内发送和/或接收的指定类型的消息条数。

参数

startTimestamp	起始时间戳，单位为毫秒。
endTimestamp	结束时间戳，单位为毫秒。
direction	消息方向。
type	消息类型。

返回

返回符合条件的消息条数。调用失败时返回 0。

getMessageStatisticsById:

- (EMChatMessageStatistics *_Nullable) getMessageStatisticsById: (NSString *_Nonnull)  messageId

required

根据消息 ID 获取消息流量统计信息。

参数

messageId

消息 ID。

返回

返回消息的流量统计信息。统计数据详见 EMChatMessageStatistics。

getMessageStatisticsSizeWithStart:end:direction:type:

- (NSInteger) getMessageStatisticsSizeWithStart: (NSInteger)  startTimestamp end: (NSInteger)  endTimestamp direction: (EMMessageStatisticsDirection)  direction type: (EMMessageStatisticsType)  type

required

获取一定时间段内发送和/或接收的指定类型的消息的总流量。

消息流量单位为字节。

参数

startTimestamp	起始时间戳，单位为毫秒。
endTimestamp	结束时间戳，单位为毫秒。
direction	消息方向。
type	消息类型。

返回

返回符合条件的消息的总流量，单位字节。调用失败时返回 0。

---

该协议的文档由以下文件生成:

• HyphenateChat.framework/Headers/IEMStatisticsManager.h