AgoraChatFetchServerMessagesOption Class Reference

#import <AgoraChatFetchServerMessagesOption.h>

Inheritance diagram for AgoraChatFetchServerMessagesOption:

Instance Methods
(NSString *_Nullable from)	- __deprecated_msg

Properties
NSArray< NSString * > *_Nullable	fromIds
NSArray< NSNumber * > *_Nullable	msgTypes
NSInteger	startTime
NSInteger	endTime
AgoraChatMessageSearchDirection	direction
BOOL	isSave

Detailed Description

The parameter configuration class for pulling historical messages from the server.

Method Documentation

__deprecated_msg

- (NSString *_Nullable from) __deprecated_msg

("Use fromIds instead")

The user ID of the message sender in the group conversation.

Property Documentation

direction

- (AgoraChatMessageSearchDirection) direction

readwritenonatomicassign

The message search direction. See AgoraChatConversation.AgoraChatMessageSearchDirection.

endTime

- (NSInteger) endTime

readwritenonatomicassign

The end time for message query. The time is a UNIX time stamp in milliseconds. The default value is -1, indicating that this parameter is ignored during message query. If the start time is set to a specific time spot and the end time uses the default value -1, the SDK returns messages that are sent and received in the period that is from the start time to the current time. If the start time uses the default value -1 and the end time is set to a specific time spot, the SDK returns messages that are sent and received in the period that is from the timestamp of the first message to the current time.

fromIds

- (NSArray<NSString*>* _Nullable) fromIds

readwritenonatomicstrong

The array of user IDs of the message sender in the group conversation. If from is set, it will be used first.

isSave

- (BOOL) isSave

readwritenonatomicassign

Whether to save the retrieved messages to the database: -YES: Yes; -NO：No.

msgTypes

- (NSArray<NSNumber*>* _Nullable) msgTypes

readwritenonatomicstrong

The array of message types for query. The default value is null, indicating that all types of messages are retrieved.

startTime

- (NSInteger) startTime

readwritenonatomicassign

The start time for message query. The time is a UNIX time stamp in milliseconds. The default value is -1, indicating that this parameter is ignored during message query. If the start time is set to a specific time spot and the end time uses the default value -1, the SDK returns messages that are sent and received in the period that is from the start time to the current time. If the start time uses the default value -1 and the end time is set to a specific time spot, the SDK returns messages that are sent and received in the period that is from the timestamp of the first message to the current time.

---

The documentation for this class was generated from the following file:

• AgoraChat.framework/Headers/AgoraChatFetchServerMessagesOption.h