DBTEAMLOGGetTeamEventsContinueError

Objective-C

@interface DBTEAMLOGGetTeamEventsContinueError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLOGGetTeamEventsContinueError : NSObject, DBSerializable, NSCopying

The GetTeamEventsContinueError union.

Errors that can be raised when calling getEventsContinue.

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

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMLOGGetTeamEventsContinueErrorTag tag;

    Swift

    var tag: DBTEAMLOGGetTeamEventsContinueErrorTag { get }

  • Cursors are intended to be used quickly. Individual cursor values are normally valid for days, but in rare cases may be reset sooner. Cursor reset errors should be handled by fetching a new cursor from getEvents. The associated value is the approximate timestamp of the most recent event returned by the cursor. This should be used as a resumption point when calling getEvents to obtain a new cursor. - note: Ensure the isReset method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull reset;

    Swift

    var reset: Date { get }

Constructors

  • Initializes union class with tag state of “bad_cursor”.

    Description of the “bad_cursor” tag state: Bad cursor.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBadCursor;

    Swift

    init(badCursor: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “reset”.

    Description of the “reset” tag state: Cursors are intended to be used quickly. Individual cursor values are normally valid for days, but in rare cases may be reset sooner. Cursor reset errors should be handled by fetching a new cursor from getEvents. The associated value is the approximate timestamp of the most recent event returned by the cursor. This should be used as a resumption point when calling getEvents to obtain a new cursor.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithReset:(nonnull NSDate *)reset;

    Swift

    init(reset: Date)

    Parameters

    reset

    Cursors are intended to be used quickly. Individual cursor values are normally valid for days, but in rare cases may be reset sooner. Cursor reset errors should be handled by fetching a new cursor from getEvents. The associated value is the approximate timestamp of the most recent event returned by the cursor. This should be used as a resumption point when calling getEvents to obtain a new cursor.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “other”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “bad_cursor”.

    Declaration

    Objective-C

    - (BOOL)isBadCursor;

    Swift

    func isBadCursor() -> Bool

    Return Value

    Whether the union’s current tag state has value “bad_cursor”.

  • Retrieves whether the union’s current tag state has value “reset”.

    Note

    Call this method and ensure it returns true before accessing the reset property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isReset;

    Swift

    func isReset() -> Bool

    Return Value

    Whether the union’s current tag state has value “reset”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.