XamarinDevDays/HandsOnLab

Xamarin Dev Days Hands On Lab

Today, we will be building a cloud connected Xamarin.Forms application that will display a list of speakers at Xamarin Dev Days and show their details. We will start by building some business logic backend that pulls down json from a RESTful endpoint and then we will connect it to an Azure Mobile App backend in just a few lines of code.

Get Started

Open Start/DevDaysSpeakers.sln

This solution contains 4 projects

• DevDaysSpeakers (Portable) - Portable Class Library that will have all shared code (model, views, and view models).
• DevDaysSpeakers.Droid - Xamarin.Android application
• DevDaysSpeakers.iOS - Xamarin.iOS application
• DevDaysSpeakers.UWP - Windows 10 UWP application (can only be run from VS 2015 on Windows 10)

The DevDaysSpeakers (Portable) also has blank code files and XAML pages that we will use during the Hands on Lab.

NuGet Restore

All projects have the required NuGet packages already installed, so there will be no need to install additional packages during the Hands on Lab. The first thing that we must do is restore all of the NuGet packages from the internet.

This can be done by Right-clicking on the Solution and clicking on Restore NuGet packages...

Model

We will be pulling down information about speakers. Open the DevDaysSpeakers/Model/Speaker.cs file and add the following properties inside of the Speaker class:

public string Id { get; set; }
public string Name { get; set; }
public string Description { get; set; }
public string Website { get; set; }
public string Title { get; set; }
public string Avatar { get; set; }

View Model

The SpeakersViewModel.cs will provide all of the functionality for how our main Xamarin.Forms view will display data. It will consist of a list of speakers and a method that can be called to get the speakers from the server. It will also contain a boolean flag that will indicate if we are getting data in a background task.

Implementing INotifyPropertyChanged

INotifyPropertyChanged is important for data binding in MVVM Frameworks. This is an interface that, when implemented, lets our view know about changes to the model.

Update:

public class SpeakersViewModel
{

}

to

public class SpeakersViewModel : INotifyPropertyChanged
{

}

Simply right click and tap Implement Interface, which will add the following line of code:

public event PropertyChangedEventHandler PropertyChanged;

We will code a helper method named OnPropertyChanged that will raise the PropertyChanged event (see below). We will invoke the helper method whenever a property changes.

C# 6 (Visual Studio 2015 or Xamarin Studio on Mac)

private void OnPropertyChanged([CallerMemberName] string name = null) =>
    PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(name));

C# 5 (Visual Studio 2012 or 2013)

private void OnPropertyChanged([CallerMemberName] string name = null)
{
    var changed = PropertyChanged;

            if (changed == null)
                return;

            changed.Invoke(this, new PropertyChangedEventArgs(name));
}

Now, we can call OnPropertyChanged(); whenever a property updates. Let's create our first property now.

IsBusy

We will create a backing field and accessors for a boolean property. This will let our view know that our view model is busy so we don't perform duplicate operations (like allowing the user to refresh the data multiple times).

First, create the backing field:

private bool busy;

Next, create the property:

public bool IsBusy
{
    get { return busy; }
    set
    {
        busy = value;
        OnPropertyChanged();
    }
}

Notice that we call OnPropertyChanged(); whenever the value changes. The Xamarin.Forms binding infrastructure will subscribe to our PropertyChanged event so the UI will get notified of the change.

ObservableCollection of Speaker

We will use an ObservableCollection that will be cleared and then loaded with speakers. We will use an ObservableCollection because it has built-in support for CollectionChanged events when we Add or Remove from it. This is very nice so we don't have to call OnPropertyChanged each time.

Above the constructor of the SpeakersViewModel class definition, declare an auto-property:

public ObservableCollection<Speaker> Speakers { get; set; }

Inside of the constructor, create a new instance of the ObservableCollection:

public SpeakersViewModel()
{
    Speakers = new ObservableCollection<Speaker>();
}

GetSpeakers Method

We are now set to create a method named GetSpeakers which will retrieve the speaker data from the internet. We will first implement this with a simply HTTP request, but later update it to grab and sync the data from Azure!

First, create a method called GetSpeakers which is of type async Task (it is a Task because it is using Async methods):

private async Task GetSpeakers()
{

}

The following code will be written INSIDE of this method:

First is to check if we are already grabbing data:

private async Task GetSpeakers()
{
    if(IsBusy)
        return;
}

Next we will create some scaffolding for try/catch/finally blocks:

private async Task GetSpeakers()
{
    if (IsBusy)
        return;

    Exception error = null;
    try
    {
        IsBusy = true;

    }
    catch (Exception ex)
    {
        error = ex;
    }
    finally
    {
       IsBusy = false;
    }

}

Notice, that we set IsBusy to true and then false when we start to call to the server and when we finish.

Now, we will use HttpClient to grab the json from the server inside of the try block.

using(var client = new HttpClient())
{
    //grab json from server
    var json = await client.GetStringAsync("http://demo4404797.mockable.io/speakers");
} 

Still inside of the using, we will Deserialize the json and turn it into a list of Speakers with Json.NET:

var items = JsonConvert.DeserializeObject<List<Speaker>>(json);

Still inside of the using, we will clear the speakers and then load them into the ObservableCollection:

Speakers.Clear();
foreach (var item in items)
    Speakers.Add(item);

If anything goes wrong the catch will save the exception and AFTER the finally block we can pop up an alert:

if (error != null)
    await Application.Current.MainPage.DisplayAlert("Error!", error.Message, "OK");

The completed code should look like:

private async Task GetSpeakers()
{
    if (IsBusy)
        return;

    Exception error = null;
    try
    {
        IsBusy = true;
        
        using(var client = new HttpClient())
        {
            //grab json from server
            var json = await client.GetStringAsync("http://demo4404797.mockable.io/speakers");
            
            //Deserialize json
            var items = JsonConvert.DeserializeObject<List<Speaker>>(json);
            
            //Load speakers into list
            Speakers.Clear();
            foreach (var item in items)
                Speakers.Add(item);
        } 
    }
    catch (Exception ex)
    {
        Debug.WriteLine("Error: " + ex);
        error = ex;
    }
    finally
    {
        IsBusy = false;
    }

    if (error != null)
        await Application.Current.MainPage.DisplayAlert("Error!", error.Message, "OK");
}

Our main method for getting data is now complete!

GetSpeakers Command

Instead of invoking this method directly, we will expose it with a Command. A Command has an interface that knows what method to invoke and has an optional way of describing if the Command is enabled.

Create a new Command called GetSpeakersCommand:

public Command GetSpeakersCommand { get; set; }

Inside of the SpeakersViewModel constructor, create the GetSpeakersCommand and pass it two methods: one to invoke when the command is executed and another that determines whether the command is enabled. Both methods can be implemented as lambda expressions as shown below:

GetSpeakersCommand = new Command(
                async () => await GetSpeakers(),
                () => !IsBusy);

The only modification that we will have to make is when we set the IsBusy property, as we will want to re-evaluate the enabled function that we created. In the set of IsBusy simply invoke the ChangeCanExecute method on the GetSpeakersCommand as shown below:

set
{
    busy = value;
    OnPropertyChanged();
    //Update the can execute
    GetSpeakersCommand.ChangeCanExecute();
}

The User Interface!!!

It is now finally time to build out our first Xamarin.Forms user interface in the View/SpeakersPage.xaml

SpeakersPage.xaml

For the first page we will add a few vertically-stacked controls to the page. We can use a StackLayout to do this. Between the ContentPage tags add the following:

 <StackLayout Spacing="0">

  </StackLayout>

This will be the container where all of the child controls will go. Notice that we specified the children should have no space in between them.

Next, let's add a Button that has a binding to the GetSpeakersCommand that we created (see below). The command takes the place of a clicked handler and will be executed whenever the user taps the button.

<Button Text="Sync Speakers" Command="{Binding GetSpeakersCommand}"/>

Under the button we can display a loading bar when we are gathering data from the server. We can use an ActivityIndicator to do this and bind to the IsBusy property we created:

<ActivityIndicator IsRunning="{Binding IsBusy}" IsVisible="{Binding IsBusy}"/>

We will use a ListView that binds to the Speakers collection to display all of the items. We can use a special property called x:Name="" to name any control:

<ListView x:Name="ListViewSpeakers"
              ItemsSource="{Binding Speakers}">
        <!--Add ItemTemplate Here-->
</ListView>

We still need to describe what each item looks like, and to do so, we can use an ItemTemplate that has a DataTemplate with a specific View inside of it. Xamarin.Forms contains a few default Cells that we can use, and we will use the ImageCell that has an image and two rows of text.

Replace with:

<ListView.ItemTemplate>
    <DataTemplate>
        <ImageCell Text="{Binding Name}"
                    Detail="{Binding Title}"
                    ImageSource="{Binding Avatar}"/>
    </DataTemplate>
</ListView.ItemTemplate>

Xamarin.Forms will automatically download, cache, and display the image from the server.

Validate App.cs

Open the App.cs file and you will see the entry point for the application, which is the constructor for App(). It simply creates the SpeakersPage, and then wraps it in a navigation page to get a nice title bar.

Run the App!

Set the iOS, Android, or UWP (Windows/VS2015 only) as the startup project and start debugging.

iOS

If you are on a PC then you will need to be connected to a macOS device with Xamarin installed to run and debug the app.

If connected, you will see a Green connection status. Select iPhoneSimulator as your target, and then select the Simulator to debug on.

Android

Simply set the DevDaysSpeakers.Droid as the startup project and select a simulator to run on.

Windows 10

Ensure that you have the SQLite extension installed for UWP apps:

Go to Tools->Extensions & Updates

Under Online search for SQLite and ensure that you have SQlite for Univeral Windows Platform installed (current version 3.13.0)

Simply set the DevDaysSpeakers.UWP as the startup project and select debug to Local Machine.

Details

Now, let's do some navigation and display some Details. Let's open up the code-behind for SpeakersPage.xaml called SpeakersPage.xaml.cs.

ItemSelected Event

In the code-behind you will find the setup for the SpeakersViewModel. Under BindingContext = vm;, let's add an event to the ListViewSpeakers to get notified when an item is selected:

ListViewSpeakers.ItemSelected += ListViewSpeakers_ItemSelected;

Implement this method so it navigates to the DetailsPage:

private async void ListViewSpeakers_ItemSelected(object sender, SelectedItemChangedEventArgs e)
{
    var speaker = e.SelectedItem as Speaker;
    if (speaker == null)
        return;

    await Navigation.PushAsync(new DetailsPage(speaker));

    ListViewSpeakers.SelectedItem = null;
}

In the above code we check to see if the selected item is not null and then use the built in Navigation API to push a new page and then deselect the item.

DetailsPage.xaml

Let's now fill in the DetailsPage. Similar to the SpeakersPage, we will use a StackLayout, but we will wrap it in a ScrollView in case we have long text.

  <ScrollView Padding="10">
    <StackLayout Spacing="10">
     <!-- Detail controls here -->
    </StackLayout>    
  </ScrollView>

Now, let's add controls and bindings for the properties in the Speaker object:

<Image Source="{Binding Avatar}" HeightRequest="200" WidthRequest="200"/>
      
<Label Text="{Binding Name}" FontSize="24"/>
<Label Text="{Binding Title}" TextColor="Purple"/>
<Label Text="{Binding Description}"/>

Add two buttons. Give them names so we can add clicked handlers to them in the code behind:

<Button Text="Speak" x:Name="ButtonSpeak"/>
<Button Text="Go to Website" x:Name="ButtonWebsite"/>

Text to Speech

If we open up DetailsPage.xaml.cs we can now add a few more click handlers. Let's start with ButtonSpeak, where we will use the Text To Speech Plugin to read back the speaker's description.

In the constructor, add a clicked handler below the BindingContext:

ButtonSpeak.Clicked += ButtonSpeak_Clicked;

Then we can add the clicked handler and call the cross-platform API for text to speech:

private void ButtonSpeak_Clicked(object sender, EventArgs e)
{
    CrossTextToSpeech.Current.Speak(this.speaker.Description);
}

Open Website

Xamarin.Forms itself has some nice APIs built right in for cross platform functionality, such as opening a URL in the default browser.

Let's add another clicked handler, but this time for ButtonWebsite:

ButtonWebsite.Clicked += ButtonWebsite_Clicked;

Then, we can use the Device class to call the OpenUri method:

private void ButtonWebsite_Clicked(object sender, EventArgs e)
{
    if (speaker.Website.StartsWith("http"))
        Device.OpenUri(new Uri(speaker.Website));
}

Compile & Run

Now, we should be all set to compile and run just like before!

Connect to Azure Mobile Apps

Of course being able grab data from a RESTful end point is great, but what about a full back end? This is where Azure Mobile Apps comes in. Let's upgrade our application to use an Azure Mobile Apps back end.

Head to http://portal.azure.com and register for an account.

Once you are in the portal select the + New button and search for mobile apps and you will see the results as shown below. Select Mobile Apps Quickstart

The Quickstart blade will open, select Create

This will open a settings blade with 4 settings:

App name

This is a unique name for the app that you will need when you configure the back end in your app. You will need to choose a globally-unique name; for example, you could try something like yourlastnamespeakers.

Subscription Select a subscription or create a pay-as-you-go account (this service will not cost you anything)

Resource Group Select Create new and call it DevDaysSpeakers

A resource group is a group of related services that can be easily deleted later.

App Service plan/Location Click this field and select Create New, give it a unique name, select a location (typically you would choose a location close to your customers), and then select the F1 Free tier:

Finally check Pin to dashboard and click create:

This will take about 3-5 minutes to setup, so let's head back to the code!

Update App.cs

We will be using the Azure App Service Helpers library that we saw earlier in the presentations to add an Azure back end to our mobile app in just four lines of code.

In the DevDaysSpeakers/App.cs file let's add a static property above the constructor for the Azure Client:

public static IEasyMobileServiceClient AzureClient { get; set; }

In the constructor, simply add the following lines of code to create the client and register the table:

AzureClient = EasyMobileServiceClient.Create();
AzureClient.Initialize("https://YOUR-APP-NAME-HERE.azurewebsites.net");
AzureClient.RegisterTable<Model.Speaker>();
AzureClient.FinalizeSchema();

Be sure to udpate YOUR-APP-NAME-HERE with the app name you just specified.

Update SpeakersViewModel.cs

Back in the ViewModel, we can add another private property to get a reference for the table. Above the constructor add:

ITableDataStore<Speaker> table;

Inside of the constructor use the static AzureClient to get the table:

table = App.AzureClient.Table<Speaker>();

Update async Task GetSpeakers()

Now, instead of using the HttpClient to get a string, let's query the Table:

Change the try block of code to:

 try
{
    IsBusy = true;
    
    var items = await table.GetItemsAsync();

    Speakers.Clear();
    foreach (var item in items)
        Speakers.Add(item);
}

Now, we have implemented all of the code we need in our app! Amazing isn't it! That's it! App Service Helpers will automatically handle all communication with your Azure back end for you, do online/offline synchronization so your app works even when it's not connected, and even perform automatic conflict resolution. Just 7 lines of code!

Let's head back to the Azure Portal and populate the database.

When the Quickstart finishes you should see the following screen, or can go to it by tapping the pin on the dashboard:

Under Features select Easy Tables.

It will have created a TodoItem, which you should see, but we can create a new table and upload a default set of data by selecting Add from CSV from the menu.

Ensure that you have downloaded this repo and have the Speaker.csv file that is in this folder.

Select the file and it will add a new table name and find the fields that we have listed. Then hit Start Upload.

Now you can re-run your application and get data from Azure!

Bonus Take Home Challenges

Take Dev Days further with these additional challenges that you can complete at home after Dev Days ends.

Challenge 1: Cognitive Services

For fun, you can add the Cognitive Serivce Emotion API and add another Button to the detail page to analyze the speaker's face for happiness level.

Go to: http://microsoft.com/cognitive and create a new account and an API key for the Emotion service.

Follow these steps:

1.) Add Microsoft.ProjectOxford.Emotion nuget package to all projects

2.) Add a new class called EmotionService and add the following code (ensure you update the API key in the GetHappinessAsync call):

public class EmotionService
{
    private static async Task<Emotion[]> GetHappinessAsync(string url)
    {
        var client = new HttpClient();
        var stream = await client.GetStreamAsync(url);
        var emotionClient = new EmotionServiceClient("INSERT_EMOTION_SERVICE_KEY_HERE");

        var emotionResults = await emotionClient.RecognizeAsync(stream);

        if (emotionResults == null || emotionResults.Count() == 0)
        {
            throw new Exception("Can't detect face");
        }

        return emotionResults;
    }

    //Average happiness calculation in case of multiple people
    public static async Task<float> GetAverageHappinessScoreAsync(string url)
    {
        Emotion[] emotionResults = await GetHappinessAsync(url);

        float score = 0;
        foreach (var emotionResult in emotionResults)
        {
            score = score + emotionResult.Scores.Happiness;
        }

        return score / emotionResults.Count();
    }

    public static string GetHappinessMessage(float score)
    {
        score = score * 100;
        double result = Math.Round(score, 2);

        if (score >= 50)
            return result + " % :-)";
        else
            return result + "% :-(";
    }
}

3.) Now add a new button to the Details Page and expose it with x:Name="ButtonAnalyze

4.) Add a new clicked handler and add the async keyword to it.

5.) Call

var level = await EmotionService.GetAverageHappinessScoreAsync(this.speaker.Avatar);

6.) Then display a pop-up alert:

await DisplayAlert("Happiness Level", EmotionService.GetHappinessMessage(level), "OK");

Challenge 2: Edit Speaker Details

In this challenge we will make the speaker's Title editable.

Open DetailsPage.xaml and change the Label that is displaying the Title from:

<Label Text="{Binding Title}" TextColor="Purple"/>

to an Entry with a OneWay data binding (this means when we enter text it will not change the actual data), and a Name to expose it in the code behind.

<Entry Text="{Binding Title, Mode=OneWay}" 
             TextColor="Purple" 
             x:Name="EntryTitle"/>

Let's add a save Button under the Go To Website button.

<Button Text="Save" x:Name="ButtonSave"/>

Update SpeakersViewModel

Open SpeakersViewModel and add a new method called UpdateSpeaker(Speaker speaker), that will update the speaker, sync, and refresh the list:

 public async Task UpdateSpeaker(Speaker speaker)
{
    await table.UpdateAsync(speaker);
    await table.Sync();
    await GetSpeakers();
}

Update DetailsPage.xaml.cs

Let's update the constructor to pass in the SpeakersViewModel for the DetailsPage:

Before:

Speaker speaker;
public DetailsPage(Speaker item)
{
    InitializeComponent();
    this.speaker = item;
    ...
}

After:

Speaker speaker;
SpeakersViewModel vm;
public DetailsPage(Speaker item, SpeakersViewModel viewModel)
{
    InitializeComponent();
    this.speaker = item;
    this.vm = viewModel;
    ...
}

Under the other clicked handlers we will add another clicked handler for ButtonSave.

ButtonSave.Clicked += ButtonSave_Clicked;

When the button is clicked, we will update the speaker, and call save and then navigate back:

private async void ButtonSave_Clicked(object sender, EventArgs e)
{
    speaker.Title = EntryTitle.Text;
    await vm.UpdateSpeaker(speaker);
    await Navigation.PopAsync();
}

Finally, we will need to pass in the ViewModel when we navigate in the SpeakersPage.xaml.cs in the ListViewSpeakers_ItemSelected method:

//Pass in view model now.
await Navigation.PushAsync(new DetailsPage(speaker, vm));

There you have it!