STSGetMessagesConfiguration

@interface STSGetMessagesConfiguration : NSObject

A STSGetMessagesConfiguration object defines the request rules of how to get messages from StraaS server.

  • The target page. Default value is 1. This value should be bigger than or equal to 1. The newest message will be at page 1.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    NSNumber *_Nonnull page;

    Swift

    var page: NSNumber { get set }

  • How many messages you want each page to return. Default value is 10. This value should be in the range [1..100].

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    NSNumber *_Nonnull perPage;

    Swift

    var perPage: NSNumber { get set }

  • Oldest date of request messages. Unix time in millisecond.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
    NSNumber *oldestDate;

    Swift

    var oldestDate: NSNumber? { get set }

  • Latest date of request messages. Unix time in millisecond.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
    NSNumber *latestDate;

    Swift

    var latestDate: NSNumber? { get set }

  • Indicates in what order the message will be sorted by created date. Default value is STSGetMessagesOrderDescending.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    STSGetMessagesOrder order;

    Swift

    var order: STSGetMessagesOrder { get set }