class documentation

class GetTeamEventsContinueError(bb.Union): (source)

View In Hierarchy

Errors that can be raised when calling :meth:`dropbox.dropbox_client.Dropbox.team_log_get_events_continue`. This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar team_log.GetTeamEventsContinueError.bad_cursor: Bad cursor. :ivar datetime.datetime team_log.GetTeamEventsContinueError.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 :route:`get_events`. 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 :route:`get_events` to obtain a new cursor.

Class Method reset Create an instance of this class set to the ``reset`` tag with value ``val``.
Method get_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 :meth:`dropbox...
Method is_bad_cursor Check if the union tag is ``bad_cursor``.
Method is_other Check if the union tag is ``other``.
Method is_reset Check if the union tag is ``reset``.
Class Variable bad_cursor Undocumented
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def reset(cls, val): (source)

Create an instance of this class set to the ``reset`` tag with value ``val``. :param datetime.datetime val: :rtype: GetTeamEventsContinueError

def get_reset(self): (source)

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 :meth:`dropbox.dropbox_client.Dropbox.team_log_get_events`. 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 :meth:`dropbox.dropbox_client.Dropbox.team_log_get_events` to obtain a new cursor. Only call this if :meth:`is_reset` is true. :rtype: datetime.datetime

def is_bad_cursor(self): (source)

Check if the union tag is ``bad_cursor``. :rtype: bool

def is_other(self): (source)

Check if the union tag is ``other``. :rtype: bool

def is_reset(self): (source)

Check if the union tag is ``reset``. :rtype: bool

bad_cursor = (source)

Undocumented

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_catch_all: str = (source)

Undocumented