Class Parameters

A class which contains parameters for an IQuery

Inheritance

System.Object

Parameters

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Couchbase.Lite.Query

Assembly: Couchbase.Lite.dll

Syntax

public sealed class Parameters

Constructors

| Improve this Doc View Source

Parameters()

Default Constructor

Declaration

public Parameters()

| Improve this Doc View Source

Parameters(Parameters)

Copy constructor

Declaration

public Parameters(Parameters parameters)

Parameters

Type	Name	Description
Parameters	parameters	The object to copy values from

Methods

| Improve this Doc View Source

GetValue(String)

Gets the untyped value of the given key in the parameters

Declaration

public object GetValue(string key)

Parameters

Type	Name	Description
System.String	key	The key to lookup

Returns

Type	Description
System.Object	The value of the key, or `null` if it does not exist

| Improve this Doc View Source

SetArray(String, ArrayObject)

Sets an ArrayObject value in the parameters

Declaration

public Parameters SetArray(string name, ArrayObject value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
ArrayObject	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetBlob(String, Blob)

Sets a Blob value in the parameters

Declaration

public Parameters SetBlob(string name, Blob value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
Blob	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetBoolean(String, Boolean)

Sets a System.Boolean value in the parameters

Declaration

public Parameters SetBoolean(string name, bool value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.Boolean	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetDate(String, DateTimeOffset)

Sets a System.DateTimeOffset value in the parameters

Declaration

public Parameters SetDate(string name, DateTimeOffset value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.DateTimeOffset	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetDictionary(String, DictionaryObject)

Sets an DictionaryObject value in the parameters

Declaration

public Parameters SetDictionary(string name, DictionaryObject value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
DictionaryObject	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetDouble(String, Double)

Sets a System.Double value in the parameters

Declaration

public Parameters SetDouble(string name, double value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.Double	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetFloat(String, Single)

Sets a System.Single value in the parameters

Declaration

public Parameters SetFloat(string name, float value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.Single	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetInt(String, Int32)

Sets an System.Int32 value in the parameters

Declaration

public Parameters SetInt(string name, int value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.Int32	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetLong(String, Int64)

Sets an System.Int64 value in the parameters

Declaration

public Parameters SetLong(string name, long value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.Int64	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetString(String, String)

Sets a System.String value in the parameters

Declaration

public Parameters SetString(string name, string value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.String	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

SetValue(String, Object)

Sets an untyped value in the parameters

Declaration

public Parameters SetValue(string name, object value)

Parameters

Type	Name	Description
System.String	name	The name of the key to set
System.Object	value	The value to set

Returns

Type	Description
Parameters	The parameters object for further processing

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()