PigeonMessenger 1.0.0

PigeonMessenger

Summary

PigeonMessenger is built to mimic certain aspects of Microsoft's MesseageCenter for Xamarin.Forms. There is currently just PigeonMessenger basic. An advanced version will be added in later revisions.

Quickstart

To start using PigeonMessenger you will need to start by building a roost. A roost is where all of the Pigeon will land. Multiple roosts can have the same key since each will have their own unique id on top of their key.

-Best Practice: It is always best to have unique keys for each roost. This will avoid confusion later on for the basic system.

Build a Roost

Start by building roosts that will hold the actions that you want to call. We used linq for this demo

Pigeon.BuildRoost(
    "myStringKey", 
    data => 
    { 
        //Do something here
    });

Send a Pigeon

After a roost has been built, you then can send a Pigeon. To send a Pigeon call it and pass dat like this.

Pigeon.SendPigeon(
    "myStringKey",
    "text data string" );

Remove a Roost

When removing a roost be careful to remove the right one. Through basic version if you try and remove by a regular string key you might delete more than just one roost. To remove a roost you must specify the correct key.

Pigeon.RemoveRoosts(
    "myStringKey");