AF SDK Reference

AFSearch Methods

Save PDF

TABLE OF CONTENTS

AFSearch Methods

Save PDF

Last UpdatedNov 18, 2025
6 minute read

AFSearch Methods

The AFSearch type exposes the following members.

Methods

	Name	Description
	Aggregate	Performs all requested aggregates on the objects that match the search criteria.
	AggregateAsync	Performs all requested aggregates on the objects that match the search criteria asynchronously.
	BinnedSummaryTBin	Generates a summary broken down by the specified bins for items matching the search criteria.
	BinnedSummaryAsyncTBin	Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
	Close	Closes the search that is cached in the server.
	ConvertAFPatternToRegexPattern	Convert an AF query pattern to a pattern that can be used with .NET Regex class.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FindObjectFields(String, Int32, Int32)	This method will return the values as an IList for the specified fields for each of the objects that match the search tokens.
	FindObjectFieldsTObject(Int32, Int32)	This method will return the values for the fields defined by the user-defined type for each of the objects that match the search tokens.
	FindObjectFieldsTObject(String, FuncIListObject, TObject, Int32, Int32)	This method will return the values as an object for the specified fields for each of the objects that match the search tokens using the supplied factory delegate.
	FindObjectIds	This method will return a list of the ID for each object that matches the search tokens.
	FrequencyDistribution	Generates a frequency distribution for the specified items.
	FrequencyDistributionAsync	Generates a frequency distribution for the specified items asynchronously.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetTotalCount	Returns the total count of the items that could be returned from the search query.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GroupedSummary	Generates summaries broken down by group for items matching the search criteria.
	GroupedSummaryAsync	Generates summaries broken down by group for items matching the search criteria asynchronously.
	HistogramTBin	Generates a histogram using the specified weighting for items matching this search.
	HistogramAsyncTBin	Generates a histogram using the specified weighting for items matching this search asynchronously.
	ParseQuery	Obsolete. Parses the specified search query into search tokens which can be used to search for objects.
	ParseQueryString	Parses the specified search query into search tokens which can be used to search for objects.
	Refresh	Refreshes the search that is cached in the server.
	Summary(String, AFSummaryTypes)	Summarizes the result of this search.
	Summary(String, AFSummaryTypes, String)	Summarizes the result of this search with the specified weighting.
	SummaryAsync(String, AFSummaryTypes, CancellationToken)	Summarizes the result of this search asynchronously.
	SummaryAsync(String, AFSummaryTypes, String, CancellationToken)	Summarizes the result of this search with the specified weighting asynchronously.
	ToString	Returns a String that represents the current object. (Overrides ObjectToString.)
	TryFindSearchToken	Obsolete. Find the AFSearchToken associated with the specified AFSearchFilter.
	TryFindSearchTokens	Obsolete. Find the AFSearchToken list associated with the specified AFSearchFilter.

AF SDK Reference

AFSearch Methods

Table of Contents

AFSearch Methods

Methods

See Also

Reference

In This Topic

Related Links