DBTEAMLOGGetTeamEventsResult

Objective-C

@interface DBTEAMLOGGetTeamEventsResult : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLOGGetTeamEventsResult : NSObject, DBSerializable, NSCopying

The GetTeamEventsResult struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • List of events. Note that events are not guaranteed to be sorted by their timestamp value.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBTEAMLOGTeamEvent *> *_Nonnull events;

    Swift

    var events: [DBTEAMLOGTeamEvent] { get }

  • Pass the cursor into getEventsContinue to obtain additional events. The value of cursor may change for each response from getEventsContinue, regardless of the value of hasMore; older cursor strings may expire. Thus, callers should ensure that they update their cursor based on the latest value of cursor after each call, and poll regularly if they wish to poll for new events. Callers should handle reset exceptions for expired cursors.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull cursor;

    Swift

    var cursor: String { get }

  • Is true if there may be additional events that have not been returned yet. An additional call to getEventsContinue can retrieve them. Note that hasMore may be true, even if events is empty.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull hasMore;

    Swift

    var hasMore: NSNumber { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEvents:
                            (nonnull NSArray<DBTEAMLOGTeamEvent *> *)events
                                cursor:(nonnull NSString *)cursor
                               hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(events: [DBTEAMLOGTeamEvent], cursor: String, hasMore: NSNumber)

    Parameters

    events

    List of events. Note that events are not guaranteed to be sorted by their timestamp value.
    cursor

    Pass the cursor into getEventsContinue to obtain additional events. The value of cursor may change for each response from getEventsContinue, regardless of the value of hasMore; older cursor strings may expire. Thus, callers should ensure that they update their cursor based on the latest value of cursor after each call, and poll regularly if they wish to poll for new events. Callers should handle reset exceptions for expired cursors.
    hasMore

    Is true if there may be additional events that have not been returned yet. An additional call to getEventsContinue can retrieve them. Note that hasMore may be true, even if events is empty.

    Return Value

    An initialized instance.