InterestQuery Class

Namespace: Improbable.Gdk.QueryBasedInterestSource

Utility class to help construct ComponentInterest.Query objects.


Static Methods

Query Source
InterestQuery Query(Constraint constraint)

Creates an InterestQuery.

Returns:
An InterestQuery object.

Parameters

Notes:
  • Returns the full snapshot result by default.


Methods

WithMaxFrequencyHz Source
InterestQuery WithMaxFrequencyHz(float frequencyHz)

Sets the maximum frequency (Hz) of the query.

Returns:
An updated InterestQuery object.

Parameters
  • float frequencyHz : The maximum frequency (Hz) to return query results.

Notes:
  • A frequency of 0 means there will be no rate limiting.

FilterResults Source
InterestQuery FilterResults(uint resultComponentId, params uint[] resultComponentIds)

Defines what components to return in the query results.

Returns:
An updated InterestQuery object.

Parameters
  • uint resultComponentId : First ID of a component to return from the query results.
  • params uint[] resultComponentIds : Further IDs of components to return from the query results.

Notes:
  • At least one component ID must be provided.

FilterResults Source
InterestQuery FilterResults(IEnumerable<uint> resultComponentIds)

Defines what components to return in the query results.

Returns:
An updated InterestQuery object.

Parameters
  • IEnumerable<uint> resultComponentIds : Set of IDs of components to return from the query results.

Notes:
  • At least one component ID must be provided. Query results are not filtered if resultComponentIds is empty.

AsComponentInterestQuery Source
ComponentInterest.Query AsComponentInterestQuery()

Returns the underlying ComponentInterest.Query object from the InterestQuery class.

Updated about a year ago


InterestQuery Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.