CBLQueryParameters

@interface CBLQueryParameters : NSObject

/**
 Set the value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The object.
 @pram name The parameter name.
 */
- (void) setValue: (nullable id)value forName: (NSString*)name;

/**
 Set the String value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The String value.
 @pram name The parameter name.
 */
- (void) setString: (nullable NSString*)value forName: (NSString*)name;

/**
 Set the NSNumber value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The NSNumber value.
 @pram name The parameter name.
 */
- (void) setNumber: (nullable NSNumber*)value forName: (NSString*)name;

/**
 Set the integer value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The integer value.
 @pram name The parameter name.
 */
- (void) setInteger: (NSInteger)value forName: (NSString*)name;

/**
 Set the long long value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The long long value.
 @pram name The parameter name.
 */
- (void) setLongLong: (long long)value forName: (NSString*)name;

/**
 Set the float value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The float value.
 @pram name The parameter name.
 */
- (void) setFloat: (float)value forName: (NSString*)name;

/**
 Set the double value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The double value.
 @pram name The parameter name.
 */
- (void) setDouble: (double)value forName: (NSString*)name;

/**
 Set the boolean value to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The boolean value.
 @pram name The parameter name.
 */
- (void) setBoolean: (BOOL)value forName: (NSString*)name;

/**
 Set the NSDate object to the query parameter referenced by the given name. A query parameter
 is defined by using the CBLQueryExpression's + parameterNamed: method.
 
 @param value The NSDate value.
 @pram name The parameter name.
 */
- (void) setDate: (nullable NSDate*)value forName: (NSString*)name;

/**
 Get the parameter value.
 
 @param name The name of the parameter.
 @return The value of the parameter.
 */
- (nullable id) valueForName: (NSString*)name;

/**
 Initializes the CBLQueryParameters object.
 */
- (instancetype) init;

/**
 Initializes the CBLQueryParameters object with the parameters object.
 */
- (instancetype) initWithParameters: (nullable CBLQueryParameters*)parameters;

@end

Undocumented

  • Set the value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setValue:(nullable id)value forName:(nonnull NSString *)name;

    Swift

    func setValue(_ value: Any?, forName name: String)

    Parameters

    value

    The object. @pram name The parameter name.

  • Set the String value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setString:(nullable NSString *)value forName:(nonnull NSString *)name;

    Swift

    func setString(_ value: String?, forName name: String)

    Parameters

    value

    The String value. @pram name The parameter name.

  • Set the NSNumber value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setNumber:(nullable NSNumber *)value forName:(nonnull NSString *)name;

    Swift

    func setNumber(_ value: NSNumber?, forName name: String)

    Parameters

    value

    The NSNumber value. @pram name The parameter name.

  • Set the integer value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setInteger:(NSInteger)value forName:(nonnull NSString *)name;

    Swift

    func setInteger(_ value: Int, forName name: String)

    Parameters

    value

    The integer value. @pram name The parameter name.

  • Set the long long value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setLongLong:(long long)value forName:(nonnull NSString *)name;

    Swift

    func setLongLong(_ value: Int64, forName name: String)

    Parameters

    value

    The long long value. @pram name The parameter name.

  • Set the float value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setFloat:(float)value forName:(nonnull NSString *)name;

    Swift

    func setFloat(_ value: Float, forName name: String)

    Parameters

    value

    The float value. @pram name The parameter name.

  • Set the double value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setDouble:(double)value forName:(nonnull NSString *)name;

    Swift

    func setDouble(_ value: Double, forName name: String)

    Parameters

    value

    The double value. @pram name The parameter name.

  • Set the boolean value to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setBoolean:(BOOL)value forName:(nonnull NSString *)name;

    Swift

    func setBoolean(_ value: Bool, forName name: String)

    Parameters

    value

    The boolean value. @pram name The parameter name.

  • Set the NSDate object to the query parameter referenced by the given name. A query parameter is defined by using the CBLQueryExpression’s + parameterNamed: method.

    Declaration

    Objective-C

    - (void)setDate:(nullable NSDate *)value forName:(nonnull NSString *)name;

    Swift

    func setDate(_ value: Date?, forName name: String)

    Parameters

    value

    The NSDate value. @pram name The parameter name.

  • Get the parameter value.

    Declaration

    Objective-C

    - (nullable id)valueForName:(nonnull NSString *)name;

    Swift

    func value(forName name: String) -> Any?

    Parameters

    name

    The name of the parameter.

    Return Value

    The value of the parameter.

  • Initializes the CBLQueryParameters object.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    init()
  • Initializes the CBLQueryParameters object with the parameters object.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithParameters:
        (nullable CBLQueryParameters *)parameters;

    Swift

    init(parameters: CBLQueryParameters?)