Interface ISortBuilder
Interface for a class that can build REST API sort query strings.
See Tableau API Reference for more details.
Namespace: Tableau.Migration.Net.Rest.Sorting
Assembly: Tableau.Migration.dll
Syntax
public interface ISortBuilderProperties
IsEmpty
Gets whether the builder contains any sorts.
Declaration
bool IsEmpty { get; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
AddSort(Sort)
Adds a sort to the builder.
Declaration
ISortBuilder AddSort(Sort sort)Parameters
| Type | Name | Description |
|---|---|---|
| Sort | sort | The sort to add. |
Returns
| Type | Description |
|---|---|
| ISortBuilder | The current ISortBuilder instance. |
AddSorts(params Sort[])
Adds sorts to the builder.
Declaration
ISortBuilder AddSorts(params Sort[] sorts)Parameters
| Type | Name | Description |
|---|---|---|
| Sort[] | sorts | The sorts to add. |
Returns
| Type | Description |
|---|---|
| ISortBuilder | The current ISortBuilder instance. |
AppendQueryString(IQueryStringBuilder)
Appends the added sorts to the specified IQueryStringBuilder instance.
Declaration
void AppendQueryString(IQueryStringBuilder builder)Parameters
| Type | Name | Description |
|---|---|---|
| IQueryStringBuilder | builder | The IQueryStringBuilder to append to. |
Build()
Builds the string value for the sorts for use in query strings.
Declaration
string Build()Returns
| Type | Description |
|---|---|
| string | The formatted string representation of the sorts. |