#import <IAgoraChatStatisticsManager.h>
Instance Methods | |
| (AgoraChatMessageStatistics *_Nullable) | - getMessageStatisticsById: |
| (NSInteger) | - getMessageCountWithStart:end:direction:type: |
| (NSInteger) | - getMessageStatisticsSizeWithStart:end:direction:type: |
Detailed Description
The protocol that defines statistical operations of message traffic.
This protocol contains methods that are used to calculate the number of local messages of certain types sent and/or received in a specified period, as well as their traffic.
This traffic statistics function is disabled by default. To use this function, you need to enable it by setting AgoraChatOptions#enableStatistics prior to the SDK initialization. The SDK can collect statistics of messages that are sent and received after this function is enabled.
The SDK only calculates the traffic of messages that are sent and received within the last 30 days after the traffic statistics function is enabled.
The message traffic is calculated as follows:
- For a text, command, location or custom message, the message traffic is the traffic of the message body.
- For an image or video message, the message traffic is the traffic sum of the message body, the image or video file, and the thumbnail.
- For a file or voice message, the message traffic is the traffic sum of the message body and the attachment.
- Note
- For messages with attachments, the traffic will be calculated only if the download is successful. If an attachment is downloaded multiple times, its download traffic will be accumulated.
- For roaming messages pulled from the server, if they already exist in the local database, the SDK ignores them during traffic calculation.
The SDK only measures the traffic of local messages, but not the actual message traffic. Generally, the calculated traffic volume is smaller than the actual traffic because of the following:
- The traffic of the common protocol data generated during message sending is not considered;
- For the received messages, the server aggregates them and adds common fields. During traffic statistics, the SDK only calculates the traffic of individual messages, but ignoring the traffic of common fields.
Method Documentation
◆ getMessageCountWithStart:end:direction:type:
|
required |
Gets the count of messages of certain types that are sent and/or received in a specified period.
- Parameters
-
startTimestamp The starting timestamp for statistics. The unit is millisecond. endTimestamp The ending timestamp for statistics. The unit is millisecond. direction The message direction. type The message type.
- Returns
- The count of messages that meet the statistical conditions.
0is returned in the case of a call failure.
◆ getMessageStatisticsById:
|
required |
Gets the message traffic statistics by message ID.
- Parameters
-
messageId The message ID.
- Returns
- The message traffic statistics.
◆ getMessageStatisticsSizeWithStart:end:direction:type:
|
required |
Gets the total traffic amount of messages that meet the statistical conditions.
The traffic is measured in bytes.
- Parameters
-
startTimestamp The starting timestamp for statistics. The unit is millisecond. endTimestamp The ending timestamp for statistics. The unit is millisecond. direction The message direction. type The message type.
- Returns
- The total traffic amount of messages that meet the statistical conditions.
0is returned in the case of a call failure.
The documentation for this protocol was generated from the following file:
- AgoraChat.framework/Headers/IAgoraChatStatisticsManager.h
