C# Class IBM.Cloudant.Client.CloudantClient

The main object for the Cloudant client public API.

This class is used for creating, deleting, or connecting to a Cloudant database.

Show file Open project: cloudant/xamarin-cloudant Class Usage Examples

Public Properties

Property	Type	Description
httpHelper	HttpHelper

Public Methods

Method	Description
CloudantClient ( CloudantClientBuilder builder ) : System	Constructs a new instance of this class and connects to the cloudant server using a builder class.
Database ( String dbname ) : Database	Creates a database object that represents a database on the server. However the database may not exist on the server yet. You should call IBM.Cloudant.Client.Database.EnsureExistsAsync to ensure the database exists on the server before performing reads or writes.

Private Methods

Method	Description
InitHttpHelper ( List interceptors ) : void

Method Details

CloudantClient() public method

Constructs a new instance of this class and connects to the cloudant server using a builder class.

public CloudantClient ( CloudantClientBuilder builder ) : System
builder	CloudantClientBuilder	Builder class.
return	System

Database() public method

Creates a database object that represents a database on the server. However the database may not exist on the server yet. You should call IBM.Cloudant.Client.Database.EnsureExistsAsync to ensure the database exists on the server before performing reads or writes.

public Database ( String dbname ) : Database
dbname	String	name of database to access
return	Database

Property Details

httpHelper public property

HttpHelper object used by this client instance to execute http requests.

public HttpHelper,IBM.Cloudant.Client httpHelper
return	HttpHelper