Class GeoHaystackSearchOptions

Namespace

MongoDB.Driver.Builders

Assembly

MongoDB.Driver.Legacy.dll

A builder for the options of the GeoHaystackSearch command.

[Obsolete("Use GeoHaystackSearchArgs instead.")]
public static class GeoHaystackSearchOptions

Inheritance

object

GeoHaystackSearchOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Null

Gets a null value with a type of IMongoGeoHaystackSearchOptions.

public static IMongoGeoHaystackSearchOptions Null { get; }

Property Value

IMongoGeoHaystackSearchOptions

Methods

SetLimit(int)

Sets the maximum number of results to return.

public static GeoHaystackSearchOptionsBuilder SetLimit(int value)

Parameters

value int

The maximum number of results to return.

Returns

GeoHaystackSearchOptionsBuilder

The builder (so method calls can be chained).

SetMaxDistance(double)

Sets the max distance.

public static GeoHaystackSearchOptionsBuilder SetMaxDistance(double value)

Parameters

value double

The max distance.

Returns

GeoHaystackSearchOptionsBuilder

The builder (so method calls can be chained).

SetQuery(string, BsonValue)

Sets the query on the optional additional field.

public static GeoHaystackSearchOptionsBuilder SetQuery(string additionalFieldName, BsonValue value)

Parameters

additionalFieldName string

The name of the additional field.

value BsonValue

The value fo the additional field.

Returns

GeoHaystackSearchOptionsBuilder

The builder (so method calls can be chained).