Class Cursor

The cursor object

Inheritance
System.Object
Cursor
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Dropbox.Api.Paper
Assembly: Dropbox.Api.dll
Syntax
public class Cursor

Constructors

| Improve this Doc View Source

Cursor(String, Nullable<DateTime>)

Initializes a new instance of the Cursor class.

Declaration
public Cursor(string value, DateTime? expiration = null)
Parameters
Type Name Description
System.String value

The actual cursor value.
System.Nullable<System.DateTime> expiration

Expiration time of value. Some cursors might have expiration time assigned. This is a UTC value after which the cursor is no longer valid and the API starts returning an error. If cursor expires a new one needs to be obtained and pagination needs to be restarted. Some cursors might be short-lived some cursors might be long-lived. This really depends on the sorting type and order, e.g.: 1. on one hand, listing docs created by the user, sorted by the created time ascending will have undefinite expiration because the results cannot change while the iteration is happening. This cursor would be suitable for long term polling. 2. on the other hand, listing docs sorted by the last modified time will have a very short expiration as docs do get modified very often and the modified time can be changed while the iteration is happening thus altering the results.

Properties

| Improve this Doc View Source

Expiration

Expiration time of Value.

Some cursors might have expiration time assigned. This is a UTC value after which the cursor is no longer valid and the API starts returning an error. If cursor expires a new one needs to be obtained and pagination needs to be restarted. Some cursors might be short-lived some cursors might be long-lived.

This really depends on the sorting type and order, e.g.:

1. on one hand, listing docs created by the user, sorted by the created time ascending will have undefinite expiration because the results cannot change while the iteration is happening. This cursor would be suitable for long term polling.

2. on the other hand, listing docs sorted by the last modified time will have a very short expiration as docs do get modified very often and the modified time can be changed while the iteration is happening thus altering the results.

Declaration
public DateTime? Expiration { get; protected set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

Value

The actual cursor value.

Declaration
public string Value { get; protected set; }
Property Value
Type Description
System.String

See Also