Open this page in the API Guide

ITokenService.TokenQuery Method

Gets the tokens corresponding to the query criteria.

Namespace:  Dundas.BI.Data.Parameters.Tokens
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (25.1.0.1000)
Syntax
IList<TokenDefinition> TokenQuery(
	int pageNumber,
	int pageSize,
	IList<Tuple<TokenQueryField, SortDirection>>? orderBy,
	ICollection<TokenQueryFilterRule>? filter
)

Parameters

pageNumber
Type: System.Int32
The page number.
pageSize
Type: System.Int32
The number of results in each page.
orderBy
Type: System.Collections.Generic.IList<Tuple<TokenQueryField, SortDirection>>
The sort order of the result, or null if the order does not matter.
filter
Type: System.Collections.Generic.ICollection<TokenQueryFilterRule>
The filter rules which should be applied to the query, or null if no filters are required.

Return Value

Type: IList<TokenDefinition>
The collection of token definitions matching the query criteria.
Exceptions
ExceptionCondition
ArgumentOutOfRangeException

pageNumber is less than zero.

-or-

pageSize is less or equal to than zero.

InvalidOperationExceptionfilter contains invalid rule.
InvalidSessionExceptionThe caller context is not associated with a valid session.
Remarks
The results are automatically filtered to exclude tokens which are not accessible to the caller.
See Also