Home > Articles > Operating Systems, Server > MAC OS X/Other

Providing Location Service Using DependencyService in Xamarin.Forms

  • Print
  • + Share This
When your app needs to work with location information, the code that requests and then handles the user's latitude and longitude shouldn't be affected by the platform of that device. Wei-Meng Lee shows how to use Xamarin.Forms to take advantage of each platform's native features to provide location services.
Like this article? We recommend

In my previous article "Using Native Platform Features in Xamarin.Forms Through DependencyService," you learned how to implement native features on the iOS and Android mobile platforms, using the three-step design pattern of DependencyService:

  • Define an interface.
  • Implement it in each platform.
  • Use it in your Xamarin.Forms project.

In this article, you will see a concrete use of the DependencyService—getting location information. You will learn how you can display the latitude and longitude of the user from within your Xamarin.Forms application, implemented using the native location service of each platform.

Creating the Project and Declaring the Interface

To begin the project, we will combine the first two steps in the design pattern. Follow these steps:

  1. Using Xamarin Studio, create a new Blank Xamarin.Forms App project and name it LBS, as shown in Figure 1. Click Next.
  2. Figure 1 Creating and naming the project.

  3. Add an interface file to the LBS project and name it IMyLocation.cs (see Figure 2).
  4. Figure 2 Adding an interface class to the project.

  5. Populate the IMyLocation.cs file as follows:
  6. using System;
    
    namespace LBS
    {
        public interface IMyLocation {
            void ObtainMyLocation();
            event EventHandler<ILocationEventArgs> locationObtained;
        }
        public interface ILocationEventArgs {
            double lat { get; set;}
            double lng { get; set;}
        }
    }

The IMyLocation interface contains the following:

  • A method named ObtainMyLocation(), which tries to obtain the user's location on the platform.
  • An event named locationObtained, with an argument of type ILocationEventArgs. This event will be called when the platform obtains a new location.

The ILocationEventArgs interface defines a class with two properties—lat (for latitude) and lng (for longitude). This class is for returning the result of the location service.

Implementing Location Service in Android

The following steps implement location service in Android:

  1. Add a Class file to the LBS.Droid project and name it GetMyLocation.cs (see Figure 3).
  2. Figure 3 Adding a class to the project.

  3. Populate the GetMyLocation.cs file as follows:
  4. using System;
    
    using Android.Content;
    using LBS.Droid;
    using Xamarin.Forms;
    using Android.Locations;
    [assembly: Xamarin.Forms.Dependency(typeof(GetMyLocation))]
    namespace LBS.Droid
    {
        //---event arguments containing lat and lng---
        public class LocationEventArgs: EventArgs, ILocationEventArgs {
            public double lat { get; set;}
            public double lng { get; set;}
        }
    
        public class GetMyLocation: Java.Lang.Object,
                                    IMyLocation,
                                    ILocationListener {
            LocationManager lm;
            public void OnProviderDisabled (string provider) { }
            public void OnProviderEnabled (string provider) { }
            public void OnStatusChanged (string provider,
                Availability status, Android.OS.Bundle extras) { }
            //---fired whenever there is a change in location---
            public void OnLocationChanged (Location location) {
                if (location != null) {
                    LocationEventArgs args = new LocationEventArgs();
                    args.lat = location.Latitude;
                    args.lng = location.Longitude;
                    locationObtained(this, args);
                };
            }
            //---an EventHandler delegate that is called when a location
            // is obtained---
            public event EventHandler<ILocationEventArgs>
                locationObtained;
            //---custom event accessor that is invoked when client
            // subscribes to the event---
            event EventHandler<ILocationEventArgs>
                IMyLocation.locationObtained {
                add {
                    locationObtained += value;
                }
                remove {
                    locationObtained -= value;
                }
            }
            //---method to call to start getting location---
            public void ObtainMyLocation ()
            {
                lm = (LocationManager)
                    Forms.Context.GetSystemService(
                        Context.LocationService);
                lm.RequestLocationUpdates(
                    LocationManager.NetworkProvider,
                        0,   //---time in ms---
                        0,   //---distance in metres---
                        this);
            }
            //---stop the location update when the object is set to
            // null---
            ~GetMyLocation() {
                lm.RemoveUpdates (this);
            }
        }
    }

    The code above performs the following tasks:

    1. Implement the ILocationEventArgs interface, using the LocationEventArgs class.
    2. Implement the IMyLocation interface, using the GetMyLocation class.
    3. In Android, the LocationManager class helps in obtaining location information; hence, the GetMyLocation class also implements the ILocationListener interface.
    4. Implement four methods of the ILocationListener interface in the GetMyLocation class:
      • OnProviderDisabled. Fired when the location service provider has been disabled by the user.
      • OnProviderEnabled. Fired when the location service provider has been enabled by the user.
      • OnStatusChanged. Fired when the location service provider's status has changed.
      • OnLocationChanged. Fired when the location changes.
    5. Whenever there is a change in location, create an instance of the LocationEventArgs class and set its lat and lng properties. Then call the locationObtained event, passing it a copy of LocationEventArgs.
    6. The ObtainMyLocation method starts the LocationManager in order to obtain the current location.
    7. For this example, use the NetworkProvider (using cellular network and WiFi) to obtain the location.
  5. Double-click the LBS.Droid project and select Android Application (see Figure 4). Select the AccessFineLocation permission.
  6. Figure 4 Adding a permission to the project.

That's it for the Android project.

Implementing Location Service in iOS

Follow these steps to implement location service on iOS:

  1. Add a Class file to the LBS.iOS project and name it GetMyLocation.cs (see Figure 5).
  2. Figure 5 Adding a class to the project.

  3. Populate the GetMyLocation.cs file as follows:
  4. using System;
    
    
    using CoreLocation;
    using LBS.iOS;
    [assembly: Xamarin.Forms.Dependency(typeof(GetMyLocation))]
    namespace LBS.iOS
    {
        //---event arguments containing lat and lng---
        public class LocationEventArgs: EventArgs, ILocationEventArgs {
            public double lat { get; set;}
            public double lng { get; set;}
        }
        public class GetMyLocation: IMyLocation
        {
            CLLocationManager lm;
            //---an EventHandler delegate that is called when a
            // location is obtained---
            public event EventHandler<ILocationEventArgs>
                locationObtained;
            //---custom event accessor when client subscribes
            // to the event---
            event EventHandler<ILocationEventArgs>
                IMyLocation.locationObtained {
                add {
                    locationObtained += value;
                }
                remove {
                    locationObtained -= value;
                }
            }
            //---method to call to start getting location---
            public void ObtainMyLocation ()
            {
                lm = new CLLocationManager();
                lm.DesiredAccuracy = CLLocation.AccuracyBest;
                lm.DistanceFilter = CLLocationDistance.FilterNone;
                //---fired whenever there is a change in location---
                lm.LocationsUpdated +=
                    (object sender, CLLocationsUpdatedEventArgs e) => {
                    var locations = e.Locations;
                    var strLocation =
                        locations[locations.Length-1].
                            Coordinate.Latitude.ToString();
                    strLocation = strLocation + "," +
                        locations[locations.Length-1].
                            Coordinate.Longitude.ToString();
                    LocationEventArgs args = new LocationEventArgs();
                    args.lat = locations[locations.Length-1].
                        Coordinate.Latitude;
                    args.lng = locations[locations.Length-1].
                        Coordinate.Longitude;
                    locationObtained(this, args);
                };
                lm.AuthorizationChanged += (object sender,
                    CLAuthorizationChangedEventArgs e) => {
                    if (e.Status ==
                        CLAuthorizationStatus.AuthorizedWhenInUse) {
                        lm.StartUpdatingLocation();
                    }
                };
                lm.RequestWhenInUseAuthorization ();
            }
            //---stop the location update when the object is set to
            // null---
            ~GetMyLocation() {
                lm.StopUpdatingLocation();
            }
        }
    }
  5. The code above performs the following tasks:
    1. Implement the ILocationEventArgs interface, using the LocationEventArgs class.
    2. Implement the IMyLocation interface, using the GetMyLocation class.
    3. iOS uses the CLLocationManager class to obtain location information. To obtain the user's location, request the user's approval by calling the RequestWhenInUseAuthorization() method.
    4. When authorization is given, call the AuthorizationChanged event of the CLLocationManager class. Then start updating the locations.
    5. When a new location is obtained, fire the LocationsUpdated event. Pass the locations in through an array, with the last element being the most recent location. Create an instance of the LocationEventArgs class and set its lat and lng properties. Call the locationObtained event and pass a copy of LocationEventArgs to it.
  6. In the Info.plist file of the LBS.iOS project, add a new key and set its value as shown in Figure 6.
  7. Figure 6 Adding a new key to the Info.plist file.

This key is needed to obtain permission from the user so that your app can obtain location information.

Using the GetMyLocation Class

Now that both platforms have implemented the IMyLocation interface, you are ready to use them in your Xamarin.Forms project. Follow these steps:

  1. Add the following statements in bold to the LBS.cs file:
  2. using System;
    
    using Xamarin.Forms;
    
    namespace LBS
    {
        public class App : Application
        {
            Label lblLat, lblLng;
            IMyLocation loc;
    
            public App ()
            {
                lblLat = new Label {
                    XAlign = TextAlignment.Center,
                    Text = "Lat",
                };
                lblLng = new Label {
                    XAlign = TextAlignment.Center,
                    Text = "Lng",
                };
    
                // The root page of your application
                MainPage = new ContentPage {
                    Content = new StackLayout {
                        VerticalOptions = LayoutOptions.Center,
                        Children = {
                            new Label {
                                XAlign = TextAlignment.Center,
                                Text = "Current Location"
                            },
                            lblLat,
                            lblLng
                        }
                    }
                };
            }
    
            protected override void OnStart ()
            {
                // Handle when your app starts
                loc = DependencyService.Get<IMyLocation> ();
                loc.locationObtained += (object sender,
                    ILocationEventArgs e) => {
                    var lat = e.lat;
                    var lng = e.lng;
                    lblLat.Text = lat.ToString();
                    lblLng.Text = lng.ToString();
                };
                loc.ObtainMyLocation ();
            }
    
            protected override void OnSleep ()
            {
                // Handle when your app sleeps
                loc = null;
            }
    
            protected override void OnResume ()
            {
                // Handle when your app resumes
    
            }
        }
    }
  3. The code above performs the following tasks:
    1. Add two Label views on the ContentPage to display the latitude and longitude of the location.
    2. Obtain an instance of the implementation of the IMyLocation interface in the OnStart() method.
    3. Handle the locationObtained event and display the location details in the two Label views whenever a new location is obtained.
    4. Call the ObtainMyLocation() method to start getting location information.

Testing the App

To test the application on the iPhone Simulator, right-click the LBS.iOS project and select Run With > iPhone 6 iOS 8.3. You will be prompted for your permission to access your location (see Figure 7). Click Allow.

Figure 7 Testing the application on the iPhone Simulator.

To simulate getting locations on the iPhone Simulator, select Debug > Location > Freeway Drive. In Figure 8, the iPhone Simulator shows the locations it obtained.

Figure 8 Obtaining the locations on the iPhone Simulator.

You can test the Android project on a real Android device. Right-click the LBS.Droid project and select Run With > <Android Device Name>. Figure 9 shows the application displaying the locations it obtained.

Figure 9 Testing the application on an Android device.

Summary

In this article, you learned how location services can be implemented in Xamarin.Forms. While Xamarin.Forms focuses on the user interface, it also provides an elegant way for platforms to invoke native features, and location service is one such example. In the next article in this series, I will show how you can add a map to display your current location.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020