Package com.dropbox.core.v2.teamlog

Class GetTeamEventsContinueError

java.lang.Object
com.dropbox.core.v2.teamlog.GetTeamEventsContinueError
public final class GetTeamEventsContinueError extends Object
Errors that can be raised when calling DbxTeamTeamLogRequests.getEventsContinue(String).

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

  • Field Details

    • BAD_CURSOR

      public static final GetTeamEventsContinueError BAD_CURSOR
      Bad cursor.

    • OTHER

      public static final GetTeamEventsContinueError OTHER
      Catch-all used for unknown tag values returned by the Dropbox servers.

      Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

  • Method Details

    • tag

      public GetTeamEventsContinueError.Tag tag()
      Returns the tag for this instance.

      This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this GetTeamEventsContinueError.

      If a tag returned by the server is unrecognized by this SDK, the GetTeamEventsContinueError.Tag.OTHER value will be used.

      Returns:
      the tag for this instance.

    • isBadCursor

      public boolean isBadCursor()
      Returns true if this instance has the tag GetTeamEventsContinueError.Tag.BAD_CURSOR, false otherwise.
      Returns:
      true if this instance is tagged as GetTeamEventsContinueError.Tag.BAD_CURSOR, false otherwise.

    • isReset

      public boolean isReset()
      Returns true if this instance has the tag GetTeamEventsContinueError.Tag.RESET, false otherwise.
      Returns:
      true if this instance is tagged as GetTeamEventsContinueError.Tag.RESET, false otherwise.

    • reset

      public static GetTeamEventsContinueError reset(Date value)
      Returns an instance of GetTeamEventsContinueError that has its tag set to GetTeamEventsContinueError.Tag.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 DbxTeamTeamLogRequests.getEvents(com.dropbox.core.v2.teamlog.GetTeamEventsArg). 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 DbxTeamTeamLogRequests.getEvents(com.dropbox.core.v2.teamlog.GetTeamEventsArg) to obtain a new cursor.

      Parameters:
      value - value to assign to this instance.
      Returns:
      Instance of GetTeamEventsContinueError with its tag set to GetTeamEventsContinueError.Tag.RESET.
      Throws:
      IllegalArgumentException - if value is null.

    • getResetValue

      public Date getResetValue()
      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 DbxTeamTeamLogRequests.getEvents(com.dropbox.core.v2.teamlog.GetTeamEventsArg). 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 DbxTeamTeamLogRequests.getEvents(com.dropbox.core.v2.teamlog.GetTeamEventsArg) to obtain a new cursor.

      This instance must be tagged as GetTeamEventsContinueError.Tag.RESET.

      Returns:
      The Date value associated with this instance if isReset() is true.
      Throws:
      IllegalStateException - If isReset() is false.

    • isOther

      public boolean isOther()
      Returns true if this instance has the tag GetTeamEventsContinueError.Tag.OTHER, false otherwise.
      Returns:
      true if this instance is tagged as GetTeamEventsContinueError.Tag.OTHER, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toStringMultiline

      public String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.

      The returned String may contain newlines.

      Returns:
      Formatted, multiline String representation of this object