Interface IFilterBuilder

Interface for a class that can build REST API filter query strings.

See Tableau API Reference for more details.

Namespace: Tableau.Migration.Net.Rest.Filtering

Assembly: Tableau.Migration.dll

Syntax

public interface IFilterBuilder

Properties

IsEmpty

Gets whether the builder contains any filters.

Declaration

bool IsEmpty { get; }

Property Value

Type	Description
bool

Methods

AddFilter(Filter)

Adds a filter to the builder.

Declaration

IFilterBuilder AddFilter(Filter filter)

Parameters

Type	Name	Description
Filter	filter	The filter to add.

Returns

Type	Description
IFilterBuilder	The current IFilterBuilder instance.

AddFilters(IEnumerable<Filter>)

Adds filters to the builder.

Declaration

IFilterBuilder AddFilters(IEnumerable<Filter> filters)

Parameters

Type	Name	Description
IEnumerable<Filter>	filters	The filters to add.

Returns

Type	Description
IFilterBuilder	The current IFilterBuilder instance.

AddFilters(params Filter[])

Adds filters to the builder.

Declaration

IFilterBuilder AddFilters(params Filter[] filters)

Parameters

Type	Name	Description
Filter[]	filters	The filters to add.

Returns

Type	Description
IFilterBuilder	The current IFilterBuilder instance.

AppendQueryString(IQueryStringBuilder)

Appends the added filters 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 filters for use in query strings.

Declaration

string Build()

Returns

Type	Description
string	The formatted string representation of the filters.