Fauna v10 .NET/C# Driver 1.0.1
 
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
Fauna.StreamOptions Class Reference

Represents the options when subscribing to Fauna Event Streams. More...

Inheritance diagram for Fauna.StreamOptions:
Fauna.Types.EventOptions

Public Member Functions

 StreamOptions (string token, string cursor)
 Initializes a new instance of the StreamOptions class with the specified token and cursor.
 
 StreamOptions (string token, long startTs)
 Initializes a new instance of the StreamOptions class with the specified token and start timestamp.
 

Properties

string? Token [get]
 Token for a Fauna event source.
 
- Properties inherited from Fauna.Types.EventOptions
string? Cursor [get, set]
 Cursor returned from Fauna.
 
long? StartTs [get]
 Start timestamp returned for the feed. Used to resume the Feed.
 
int? PageSize [get]
 Limit page size for the Feed.
 

Detailed Description

Represents the options when subscribing to Fauna Event Streams.

Definition at line 8 of file StreamOptions.cs.

Constructor & Destructor Documentation

◆ StreamOptions() [1/2]

Fauna.StreamOptions.StreamOptions ( string  token,
string  cursor 
)

Initializes a new instance of the StreamOptions class with the specified token and cursor.

Parameters
tokenThe token for a Fauna event source.
cursorThe cursor from the stream, must be used with the associated Token. Used to resume the stream.

See Restart an Event Stream.

Definition at line 16 of file StreamOptions.cs.

◆ StreamOptions() [2/2]

Fauna.StreamOptions.StreamOptions ( string  token,
long  startTs 
)

Initializes a new instance of the StreamOptions class with the specified token and start timestamp.

Parameters
tokenThe token for a Fauna event source.
startTsThe start timestamp to use for the stream.

Definition at line 27 of file StreamOptions.cs.

Property Documentation

◆ Token

string? Fauna.StreamOptions.Token
get

Token for a Fauna event source.

See the Create an event source.

Definition at line 36 of file StreamOptions.cs.


The documentation for this class was generated from the following file: