Windows Phone 8 DLL for Kinvey BaaS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Com.Penrillian.Kinvey.Test
Com.Penrillian.Kinvey
lib
packages
Kinvey.sln
License.txt
README.md

README.md

Kinvey Support for Windows Phone 8

This project aims to provide support to Windows Phone 8 apps backed by Kinvey BaaS services.

Dependencies

These dependencies are included in this repository.

Building the DLL

You can build the solution file (Kinvey.sln) with Visual Studio 2012 in release mode either through Visual Studio or through the command line...

.../devenv.com Kinvey.sln /rebuild release

Running the Tests

A suite of N-Unit tests is provided in the Com.Penrillian.Kinvey.Test project which can be run using any test runner.

Including the Source

To include the source, instead of using a pre-build DLL, simply include the Com.Penrillian.Kinvey project in your solution. You can also include the Com.Penrillian.Kinvey.Tests project into your test suite.

Example Usage

Initialising the DLL

This MUST be done before the DLL is used by your app. It is best practice to do this during app initialization. Inform the KinveySettings class of your AuthToken and AuthKey...

    KinveySettings.Get().AppAuthToken = "h4gs56j4t8a4n1a3j4t8a34j5t34a534fgag23bcxvz=";
    KinveySettings.Get().AppKey = "MyApp";

Basic CRUD

Accessing collections is done using the IKinveyService <T> interface. The type parameter T should be a type marked with the KinveyCollection attribute, using the collection name as the parameter. Serialization attributes can be added to the properties of this class to match your collection schema...

    [KinveyCollection("giraffe")]
    public class Giraffe : KinveyObject
    {
        [JsonProperty(PropertyName = "name")]
        public string Name { get; set; }
        [JsonProperty(PropertyName = "age")]
        public int Age { get; set; }
    }

You can get an instance of an IKinveyService from the KinveyFactory class...

    var service = KinveyFactory.GetService<Giraffe>();

You can use this service object to perform TAP operations on your data...

	// Creating
    var giraffe = await service.Create(new Giraffe {Name = "Dave", Age = 42});
	// Reading
    giraffe = await service.Read(giraffe.Id);
	// Updating
    giraffe = await service.Update(giraffe);
	// Deleting
	await service.Delete(giraffe);

Querying

You can count, query and delete by query all as TAP operations...

	var giraffeCount = await dataService.Count();
	var daveCount = await dataService.Count(new KinveyQuery<Giraffe>().Constrain(g => g.Name, "Dave"));
	var daves = await dataService.Read(new KinveyQuery<Giraffe>().Constrain(g => g.Name, "Dave"));
	var deletedDaveCount = await dataService.Delete(new KinveyQuery<Giraffe>().Constrain(g => g.Name, "Dave"));

Working with Constraints

Query constraint objects give a fluid API for defining queries.

	var query = new KinveyQuery<Giraffe>();
	// constrain
	query = query.Constrain(g => g.Name, "Dave");
	// comparison constraints
	query = query.Constrain(g => g.Age, Is.GreaterThan(18));
	// removing constraints
	query = query.Release(g => g.Name);
	// custom comparison constraints
	// see: http://docs.mongodb.org/manual/reference/operator/
	query = query.Constrain(g => g.Name, Is.It("$ne", "stephen"));
	// paging
	query = query.Limit(20); // <- page 1
	query = query.Skip(20); // <- page 2
	// chaining
	query = new KinveyQuery<Giraffe>()
				.Constrain(g => g.Name, "Dave")
				.Constrain(g => g.Age, Is.GreaterThan(18))
				.Limit(20)
				.Skip(20);

It is also possible to work on sets of constraints outwith the bounds of a query object, and then build a query which will automatically adopt these constraints. This is useful if you want to build a pager which will generate multiple query objects with the same constraints.

	var constraints = new KinveyConstraints<Giraffe>()
							.Constrain(g => g.Name, "Dave")
							.Constrain(g => g.Age, Is.GreaterThan(18));
	var page1 = new Query(constraints).Limit(20).Skip(0);
	var page2 = new Query(constraints).Limit(20).Skip(20);
	var page3 = new Query(constraints).Limit(20).Skip(40);

When adopting a set of constraints after construction, the adopted constraints will be added to the query alongside the current constraints. The exception to this rule is where there are two constraints targeting the same field, the adopted constraint will be preferred.

	query = new KinveyQuery<Giraffe>()
				.Constrain(g => g.Age, Is.GreaterThan(19))
				.Limit(20)
				.Skip(20);
	var constraints = new KinveyConstraints<Giraffe>()
							.Constrain(g => g.Name, "Dave")
							.Constrain(g => g.Age, Is.GreaterThan(18));
	query.Adopt(constraints);
	// Age is now constrained by Is.GreaterThan(19)
	

Constraints can be joined using or, nor and and joins...

    var orConstraints = new[]
        {
            new KinveyConstraints<Giraffe>().Constrain(g => g.Name, "steve"), 
            new KinveyConstraints<Giraffe>().Constrain(g => g.Name, "dave")
        }.Or();
    var andConstraints = new[]
        {
            new KinveyConstraints<Giraffe>().Constrain(g => g.Name, "steve"), 
            new KinveyConstraints<Giraffe>().Constrain(g => g.Age, 19)
        }.And();

...and negated...

	var notConstraints = new KinveyConstraints<Giraffe>().Constrain(g => g.Name, "steve").Not();