KiiCloudStorageSDK : KiiCorp.Cloud.Storage Namespace

Overview

Signature

Remarks

Members

Member Details

KiiQuery Class

Represents query interface.

Syntax

public class KiiQuery

Remarks

Developers can set the conditions with KiiCorp.Cloud.Storage.KiiClause
Example
             KiiQuery q = new KiiQuery(KiiClause.GreaterThan("score", 80));
             q.Limit = 10;
             q.SortByDesc("score");

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Members

See Also: Inherited members from object.

Public Constructors

 Create Query.
Create Query from KiiCorp.Cloud.Storage.KiiClause

Public Properties

[write-only]
 Limit int . Set the maximum number of results returned on response. This limit behaves in a best effort way, actual number of returned result could be smaller than requested number but never exceed the limit.

Public Methods

 SortByAsc (string)
Sort with the specified key in ascending order.
SortByDesc (string)
Sort with the specified key in descending order.
override
ToString () : string
Returns a string that represents the current KiiCorp.Cloud.Storage.KiiQuery.

Member Details

KiiQuery Constructor

Create Query.

Syntax

public KiiQuery ()

Remarks

Matches all items in the bucket.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

KiiQuery Constructor

Create Query from KiiCorp.Cloud.Storage.KiiClause

Syntax

public KiiQuery (KiiClause clause)

Parameters

clause
Clause.

Remarks

If clause is null, matches all items in the bucket.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

Limit Property

Set the maximum number of results returned on response. This limit behaves in a best effort way, actual number of returned result could be smaller than requested number but never exceed the limit.

Syntax

public int Limit { set; }

Value

Maximum return items.

Remarks

If specified limit is <= 0, 0 will be applied. If the specified limit is greater than the limit of the server or limit is set to 0, limit defined in server will be applied.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

SortByAsc Method

Sort with the specified key in ascending order.

Syntax

public void SortByAsc (string key)

Parameters

key
Key.

Exceptions

Type Reason
ArgumentException Is thrown when key is empty.

Remarks

The type of value associated with key must be number or string.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

SortByDesc Method

Sort with the specified key in descending order.

Syntax

public void SortByDesc (string key)

Parameters

key
Key.

Exceptions

Type Reason
ArgumentException Is thrown when key is empty.

Remarks

The type of value associated with key must be number or string.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

ToString Method

Returns a string that represents the current KiiCorp.Cloud.Storage.KiiQuery.

Syntax

public override string ToString ()

Returns

A string that represents the current KiiCorp.Cloud.Storage.KiiQuery.

Remarks

Developers don't need to use this API in their apps.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0