Phants Client for Redis™*
Public Member Functions | List of all members
SortOptions Class Reference

Public Member Functions

void SetByPattern (string pattern)
 
void ClearByPattern ()
 
void SetLimit (int offset, int count)
 
void SetLimit (Limit limit)
 
void ClearLimit ()
 
void AddGetPattern (string pattern)
 
void ClearGetPatterns ()
 
void SetSortOrder (SortOrder order)
 
void ClearSortOrder ()
 
void SetAlpha (bool useAlpha)
 

Detailed Description

Options class used by the Sort() method(s).

Member Function Documentation

void AddGetPattern ( string  pattern)
inline

Adds a pattern to the list of patterns used with the GET modifier.

Parameters
patternThe pattern to add.
void ClearByPattern ( )
inline

Clears/unsets the BY modifier.

The BY modifier will be omitted from the command.

void ClearGetPatterns ( )
inline

Clears/unsets the GET modifier.

The GET modifier will be omitted from the command.

void ClearLimit ( )
inline

Clears/unsets the LIMIT modifier.

The LIMIT modifier will be omitted from the command.

void ClearSortOrder ( )
inline

Clears/unsets the sort order modifiers.

Both the ASC and DESC modifiers will be omitted from the command.

void SetAlpha ( bool  useAlpha)
inline

Sets or clears the ALPHA modifier.

Parameters
useAlphaA value of true includes the ALPHA modifier, false omits it.
void SetByPattern ( string  pattern)
inline

Sets the pattern for the BY modifier.

Parameters
patternThe value of the BY modifier.
void SetLimit ( int  offset,
int  count 
)
inline

Sets the LIMIT modifier using the given values.

Parameters
offsetThe number of elements to skip.
countThe number of elements to return.
void SetLimit ( Limit  limit)
inline

Sets the LIMIT modifier with values provided by a Limit object.

Parameters
limitA Limit object specifying the number of elements to skip and the number of elements to return
void SetSortOrder ( SortOrder  order)
inline

Sets the ASC or DESC modifier.

Note: the ASC and DESC modifiers are mutually exclusive.

Parameters
orderThe value of the sort order modifier.

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