Cordova/cordova plugin geolocation

 توفر هذه الإضافة معلومات حول الموقع الجغرافي للجهاز، مثل خط العرض وخط الطول.

من الطرق الشائعة لتحديد معلومات الموقع الجغرافي، نجد: نظام تحديد المواقع العالمي (GPS)، واستنتاج الموقع من إشارات الشبكة، مثل عنوان IP، وعناوين تحديد الهوية بموجات الراديو (RFID)، واللاسلكي (WiFi)، وعناوين MAC Bluetooth، ومُعرِّفات الخلية GSM/CDMA.

ليس هناك ما يضمن أنّ الواجهة البرمجية ستعيد الموقع الفعلي للجهاز. لمعرفة كيفية استخدام هذه الإضافة، اطلع على الأمثلة التوضيحية في أسفل هذه الصفحة، أو انتقل مباشرة إلى المرجع.

تأسست الواجهة البرمجية لهذه الإضافة على مواصفات الواجهة البرمجية لتحديد المواقع الجغرافية من W3C ، ولا تُنفّذ إلا على الأجهزة التي لا توفر تقديما (implementation) جاهزًا سلفًا.

تنبيه: جمع واستخدام بيانات تحديد الموقع الجغرافي تثير مخاوف بخصوص قضايا الخصوصية. يجب أن تُوضّح سياسة الخصوصية في تطبيقك كيفية استخدام التطبيق لبيانات تحديد الموقع الجغرافي، وما إن كانت ستُتَشارك مع أي أطراف أخرى، ومستوى دقة البيانات (على سبيل المثال، هل المعلومات ستكون تقريبية، أم دقيقة، أم تستهدف الرمز البريدي، وما إلى ذلك). عموما، تعتبر بيانات تحديد الموقع الجغرافي حساسة، لأنها قد تُستخدم لمعرفة مكان المستخدم، وفي حال تخزينها، فستكشف تاريخ سفرياتهم وتحركاتهم. لذلك، فبالإضافة إلى سياسة خصوصية التطبيق، سيكون من الجيد تقديم إشعار فوري قبل محاولة تطبيقك الوصول إلى بيانات الموقع الجغرافي (إن لم يكن نظام التشغيل يفعل ذلك سلفًا). ينبغي أن يوفر هذا الإشعار نفس المعلومات المذكورة أعلاه، إضافة إلى استئذان المُستخدم (على سبيل المثال، عبر تقديم خيارات من قبيل حسنًا و لا شكرًا). لمزيد من المعلومات، يرجى الاطلاع على دليل الخصوصية.

تعرّف هذه الإضافة كائنًا عامًّا navigator.geolocation (في المنصات التي لا يكون مُعرّفا فيها).

على الرغم من أن هذا الكائن موجود في النطاق العام (global scope)، إلا أن الميزات التي يوفرها لن تكون متاحة إلا بعد إطلاق الحدث deviceready.

document.addEventListener("deviceready", onDeviceReady, false);
    function onDeviceReady() {
        console.log("navigator.geolocation works well");
    }‎

التثبيت

تتطلب إضافة تحديد الموقع الجغرافي كوردوفا 5.0 أوما بعدها (الإصدار المستقر الحالي 1.0.0)

cordova plugin add cordova-plugin-geolocation‎

لا يزال بإمكان الإصدارات القديمة من كوردوفا تثبيت هذه الإضافة عبر المُعرِّف المُتجاوز (الإصدار المستقر 0.3.12)

cordova plugin add org.apache.cordova.geolocation‎

من الممكن أيضًا تثبيت هذه الإضافة عبر عنوان مستودع git مباشرة (إلا أنه غير مستقر)

cordova plugin add https://github.com/apache/cordova-plugin-geolocation.git‎

المنصات المدعومة

• أندرويد
• iOS
• ويندوز

التوابع

• navigator.geolocation.getCurrentPosition
• navigator.geolocation.watchPosition
• navigator.geolocation.clearWatch

الكائنات (للقراءة فقط)

• Position
• PositionError
• Coordinates

navigator.geolocation.getCurrentPosition

يُعيد هذا التابع الموضع الحالي للجهاز إلى دالة الاستجابة (callback) ‏geolocationSuccess مع تمرير الكائن Position كمعامل. إذا كان هناك خطأ، فسيُمرّر لدالة الاستجابة geolocationError الكائن PositionError.

navigator.geolocation.getCurrentPosition(geolocationSuccess,
                                         [geolocationError],
                                         [geolocationOptions]);‎

الوسائط

• geolocationSuccess: دالة الاستجابة (callback) التي سيُمرّر إليها الموضع الحالي.
• geolocationError: (اختياري) دالة الاستجابة التي ستُنفذ في حالة حدوث خطأ.
• geolocationOptions: (اختياري) خيارات تحديد الموقع الجغرافي.

مثال

// onSuccess Callback
    // This method accepts a Position object, which contains the
    // current GPS coordinates
    //
    var onSuccess = function(position) {
        alert('Latitude: '          + position.coords.latitude          + '\n' +
              'Longitude: '         + position.coords.longitude         + '\n' +
              'Altitude: '          + position.coords.altitude          + '\n' +
              'Accuracy: '          + position.coords.accuracy          + '\n' +
              'Altitude Accuracy: ' + position.coords.altitudeAccuracy  + '\n' +
              'Heading: '           + position.coords.heading           + '\n' +
              'Speed: '             + position.coords.speed             + '\n' +
              'Timestamp: '         + position.timestamp                + '\n');
    };
    // onError Callback receives a PositionError object
    //
    function onError(error) {
        alert('code: '    + error.code    + '\n' +
              'message: ' + error.message + '\n');
    }
    navigator.geolocation.getCurrentPosition(onSuccess, onError);‎

ملاحظات خاصة بمنصة iOS

منذ الإصدار iOS 10، صار من الإلزامي تقديم وصف للاستخدام في الملف info.plist إن كنت تريد الوصول إلى بيانات حساسة. عندما يستأذن النظام المستخدم للوصول إلى تلك المعلومات، سيُعرض وصف الاستخدام ذاك كجزء من مربع حوار الاستئذان، ولكن إذا لم توفر وصف الاستخدام، فسيتعطل التطبيق قبل عرض مربع الحوار. وأيضًا، سترفض Apple التطبيقات التي تصل إلى البيانات الخاصة دون أن تقدم وصفًا للاستخدام.

تتطلب هذه الإضافات أوصاف الاستخدام التالية:

• NSLocationWhenInUseUsageDescription تصف سبب وصول التطبيق إلى موقع المستخدم.

لإضافة هذه المُدخلة إلى info.plist، يمكنك استخدام الوسم edit-config في الملف config.xml على النحو التالي:

<edit-config target="NSLocationWhenInUseUsageDescription" file="*-Info.plist" mode="merge">
    <string>need location access to find things nearby</string>
</edit-config>‎

ملاحظات خاصة بمنصة أندرويد

إذا تم إيقاف تشغيل خدمة تحديد الموقع الجغرافي، فستُستدعى دالة الاستجابة onError بعد المدة الزمنية timeout (إذا تم تحديدها). في حال عدم تحديد المعامل timeout، فلن يتم استدعاء أي دالة استجابة.

navigator.geolocation.watchPosition

يُعيد هذا التابع الموضع الحالي للجهاز عند رصد أي تغيير في الموضع. عندما يتغير موقع الجهاز، يتم تنفيذ دالة الاستجابة geolocationSuccess مع تمرير الكائن Position إليها كمعامل. إن حدث خطأ، يتم تنفيذ دالة الاستجابة geolocationError مع تمرير الكائن PositionError كمعامل.

var watchId = navigator.geolocation.watchPosition(geolocationSuccess,
                                                  [geolocationError],
                                                  [geolocationOptions]);‎

الوسائط

• geolocationSuccess: دالة الاستجابة التي سيُمرّر إليها الموضع الحالي.
• geolocationError: (اختياري) دالة الاستجابة التي ستُنفذ عند حدوث خطأ.
• geolocationOptions: (اختياري) خيارات تحديد الموقع الجغرافي.

القيمة المعادة

• String: يعاد معرف المراقبة (watch id)، الذي يشير إلى لمجال مراقبة الموضع (watch position interval). يجب استخدام مٌعرّف المراقبة مع navigator.geolocation.clearWatch لإيقاف مراقبة التغييرات في الموضع.

مثال

// onSuccess Callback
    //   This method accepts a `Position` object, which contains
    //   the current GPS coordinates
    //
    function onSuccess(position) {
        var element = document.getElementById('geolocation');
        element.innerHTML = 'Latitude: '  + position.coords.latitude      + '<br />' +
                            'Longitude: ' + position.coords.longitude     + '<br />' +
                            '<hr />'      + element.innerHTML;
    }
    // onError Callback receives a PositionError object
    //
    function onError(error) {
        alert('code: '    + error.code    + '\n' +
              'message: ' + error.message + '\n');
    }
    // Options: throw an error if no update is received every 30 seconds.
    //
    var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });‎

geolocationOptions

معاملات اختيارية تُستخدم لتخصيص عملية تحصيل معلومات الموقع الجغرافي Position.

{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };‎

خيارات

• enableHighAccuracy: يلمح إلى أنّ التطبيق يحتاج إلى الحصول على أدق النتائج الممكنة. بشكل افتراضي، يحاول الجهاز تحصيل Position باستخدام أساليب تستند إلى الشبكة. إن ضبط هذه الخاصية عند القيمة true يخبر إطار العمل بضرورة استخدام أساليب أكثر دقة، مثل تحديد الموقع عبر الأقمار الصناعية. (قيمة منطقية)
• timeout: االفترة الزمنية القصوى (بالميليثانية) المسموح به بمرورها منذ استدعاء navigator.geolocation.getCurrentPosition أو geolocation.watchPosition وحتى تنفيذ دالة الاستجابة المقابلة geolocationSuccess. إذا لم يتم استدعاء دالة الاستجابة geolocationSuccess خلال هذا الوقت، فسيُمرّر إلى دالة الاستجابة geolocationError كود الخطأ PositionError.TIMEOUT. (لاحظ أنه عند استخدامها مع geolocation.watchPosition، يمكن استدعاء دالة الاستجابة geolocationError على فواصل زمنية كل timeout ميليثانية) (عدد)
• maximumAge: يقبل موضع مخزنا مؤقتًا (cached position)، والذي لا يزيد عمره عن الوقت المحدد بالميليثانية. (عدد)

ملاحظات خاصة بمنصة أندرويد

في حال إيقاف خدمة تحديد الموقع الجغرافي، فستُستدعى دالة الاستجابة onError بعد الفاصل الزمني timeout (في حال تحديده). إذا لم يتم تحديد المعامل timeout، فلن يتم استدعاء أي دالة استجابة.

navigator.geolocation.clearWatch

يوقف هذا التابع عملية مراقبة التغييرات في موقع الجهاز، والمشار إليه من قبل المعامل watchID.

navigator.geolocation.clearWatch(watchID);‎

المعاملات

• watchID: مُعرِّف الفاصل الزمني للتابع watchPosition الذي يُراد حذفه. (سلسلة نصية)

مثال

// Options: watch for changes in position, and use the most
    // accurate position acquisition method available.
    //
    var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { enableHighAccuracy: true });
    // ...later on...
    navigator.geolocation.clearWatch(watchID);‎

Position

يحتوي هذا الكائن على إحداثيات Position وطابعه الزمني، يتم أنشاؤه من قبل الواجهة البرمجية للإضافة.

خاصيات

• coords: مجموعة من الإحداثيات الجغرافية. (احداثيات)
• timestamp: الطابع الزمني للإنشاء الخاص بالكائن coords. (DOMTimeStamp)

تُربط الكائنات Coordinates بكائن Position متوفرٍ لدوال الاستجابة الخاصة بطلبيات الموضع الحالي. يحتوي على مجموعة من الخاصيات التي تصف الإحداثيات الجغرافية للموضع.

خاصيات

• latitude: خط العرض بالدرجات العشرية. (عدد)
• longitude: خط الطول بالدرجات العشرية. (عدد)
• altitude: ارتفاع الموقع بالأمتار فوق الإهليليج (ellipsoid). (عدد)
• accuracy: مستوى الدقة لإحداثيات الطول والعرض بالأمتار. (عدد)
• altitudeAccuracy: مستوى دقة إحداثيات الإرتفاع بالأمتار. (عدد)
• heading: اتجاه السفر، محدد بعدد الدرجات في اتجاه عقارب الساعة نسبةً إلى الشمال الحقيقي. (عدد)
• speed: السرعة الأرضية الحالية للجهاز، تُحدد بعدد الأمتار المقطوعة في الثانية. (عدد)

ملاحظات خاصة بمنصة أندرويد

altitudeAccuracy: غير مدعومة في أجهزة أندرويد، تعيد null.

PositionError

يُمرّر الكائن PositionError إلى دالة الاستجابة geolocationError عند حدوث خطأ في navigator.geolocation.

خاصيات

• code: أحد رموز الخطأ المحددة مسبقًا المدرجة أدناه.
• message: رسالة خطأ تصف تفاصيل الخطأ الذي وقع.

ثوابت

• PositionError.PERMISSION_DENIED
• تُعاد هذه الثابتة عندما يرفض المستخدمون السماح للتطبيق بالوصول إلى معلومات الموقع الجغرافي. يعتمد هذا على المنصة المُستخدمة.
• PositionError.POSITION_UNAVAILABLE
• تُعاد عندما يعجز الجهاز عن الحصول على الموقع الجغرافي. بشكل عام، هذا يعني أنّ الجهاز ليس متصلًا بأي بشبكة، أو لا يمكنه الوصول إلى القمر الصناعي.
• PositionError.TIMEOUT
• تُعاد عندما يتعذر على الجهاز الحصول الموقع الجغرافي خلال الوقت المحدد بواسطة timeout المتضمَّن في geolocationOptions. عند استخدامها مع التابع navigator.geolocation.watchPosition، يمكن تمرير هذا الخطأ مراراً وتكراراً إلى دالة الاستجابة geolocationError كل timeout ميليثانية.

عينة: الحصول على الطقس، والعثور على المتاجر، ومشاهدة الصور للأشياء القريبة مع تحديد الموقع الجغرافي

يمكن أن استخدام هذه الإضافة لمساعدة المستخدمين على العثور على المواقع أو الأحداث القريبة منهم، مثل عروض Grouponأ والمنازل المعروضة للبيعأ والأفلام المعروضة حاليًا، والأحداث الرياضية والترفيهية وغير ذلك.

إليك مجموعة من الأفكار لتبدأ بها. في الشيفرات البرمجية أدناه، سنريك بعض الطرق السهلة لإضافة هذه الميزات إلى تطبيقك.

• [#coords Get your coordinates].
• [#weather Get the weather forecast].
• [#receive Receive updated weather forecasts as you drive around].
• [#see See where you are on a map].
• [#find Find stores near you].
• [#see See pictures of things around you].

الحصول على إحداثيات موقعك الجغرافي

function getWeatherLocation() {
    navigator.geolocation.getCurrentPosition
    (onWeatherSuccess, onWeatherError, { enableHighAccuracy: true });
}‎

الحصول على توقعات الطقس

// Success callback for get geo coordinates
var onWeatherSuccess = function (position) {
    Latitude = position.coords.latitude;
    Longitude = position.coords.longitude;
    getWeather(Latitude, Longitude);
}
// Get weather by using coordinates
function getWeather(latitude, longitude) {
    // Get a free key at http://openweathermap.org/. Replace the "Your_Key_Here" string with that key.
    var OpenWeatherAppKey = "Your_Key_Here";
    var queryString =
      'http://api.openweathermap.org/data/2.5/weather?lat='
      + latitude + '&lon=' + longitude + '&appid=' + OpenWeatherAppKey + '&units=imperial';
    $.getJSON(queryString, function (results) {
        if (results.weather.length) {
            $.getJSON(queryString, function (results) {
                if (results.weather.length) {
                    $('#description').text(results.name);
                    $('#temp').text(results.main.temp);
                    $('#wind').text(results.wind.speed);
                    $('#humidity').text(results.main.humidity);
                    $('#visibility').text(results.weather[0].main);
                    var sunriseDate = new Date(results.sys.sunrise);
                    $('#sunrise').text(sunriseDate.toLocaleTimeString());
                    var sunsetDate = new Date(results.sys.sunrise);
                    $('#sunset').text(sunsetDate.toLocaleTimeString());
                }
            });
        }
    }).fail(function () {
        console.log("error getting location");
    });
}
// Error callback
function onWeatherError(error) {
    console.log('code: ' + error.code + '\n' +
        'message: ' + error.message + '\n');
}‎

تلقي تحديثات توقعات الطقس أثناء القيادة

// Watch your changing position
function watchWeatherPosition() {
    return navigator.geolocation.watchPosition
    (onWeatherWatchSuccess, onWeatherError, { enableHighAccuracy: true });
}
// Success callback for watching your changing position
var onWeatherWatchSuccess = function (position) {
    var updatedLatitude = position.coords.latitude;
    var updatedLongitude = position.coords.longitude;
    if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
        Latitude = updatedLatitude;
        Longitude = updatedLongitude;
        // Calls function we defined earlier.
        getWeather(updatedLatitude, updatedLongitude);
    }
}‎

التعرف على موقعك على الخريطة

يُوفر كلٌّ من Bing و Google خدمات الخرائط. سنستخدم جوجل. ستحتاج إلى مفتاح، وهو مجاني إن كنت تحاول تجربة الخدمة.

قم بإضافة مرجع إلى الخدمة maps.

<script src="https://maps.googleapis.com/maps/api/js?key=Your_API_Key"></script>‎

ثم أضف الشيفرة التالية لاستخدامها.

var Latitude = undefined;
var Longitude = undefined;
// Get geo coordinates
function getMapLocation() {
    navigator.geolocation.getCurrentPosition
    (onMapSuccess, onMapError, { enableHighAccuracy: true });
}
// Success callback for get geo coordinates
var onMapSuccess = function (position) {
    Latitude = position.coords.latitude;
    Longitude = position.coords.longitude;
    getMap(Latitude, Longitude);
}
// Get map by using coordinates
function getMap(latitude, longitude) {
    var mapOptions = {
        center: new google.maps.LatLng(0, 0),
        zoom: 1,
        mapTypeId: google.maps.MapTypeId.ROADMAP
    };
    map = new google.maps.Map
    (document.getElementById("map"), mapOptions);
    var latLong = new google.maps.LatLng(latitude, longitude);
    var marker = new google.maps.Marker({
        position: latLong
    });
    marker.setMap(map);
    map.setZoom(15);
    map.setCenter(marker.getPosition());
}
// Success callback for watching your changing position
var onMapWatchSuccess = function (position) {
    var updatedLatitude = position.coords.latitude;
    var updatedLongitude = position.coords.longitude;
    if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
        Latitude = updatedLatitude;
        Longitude = updatedLongitude;
        getMap(updatedLatitude, updatedLongitude);
    }
}
// Error callback
function onMapError(error) {
    console.log('code: ' + error.code + '\n' +
        'message: ' + error.message + '\n');
}
// Watch your changing position
function watchMapPosition() {
    return navigator.geolocation.watchPosition
    (onMapWatchSuccess, onMapError, { enableHighAccuracy: true });
}‎

البحث عن متجر قريب

يمكنك استخدام نفس مفتاح جوجل لأجل هذا.

أضف مرجعًا إلى الخدمة places.

<script src=
"https://maps.googleapis.com/maps/api/js?key=Your_API_Key&libraries=places">
</script>‎

ثم أضف الشيفرة التالية لاستخدامها.

var Map;
var Infowindow;
var Latitude = undefined;
var Longitude = undefined;
// Get geo coordinates
function getPlacesLocation() {
    navigator.geolocation.getCurrentPosition
    (onPlacesSuccess, onPlacesError, { enableHighAccuracy: true });
}
// Success callback for get geo coordinates
var onPlacesSuccess = function (position) {
    Latitude = position.coords.latitude;
    Longitude = position.coords.longitude;
    getPlaces(Latitude, Longitude);
}
// Get places by using coordinates
function getPlaces(latitude, longitude) {
    var latLong = new google.maps.LatLng(latitude, longitude);
    var mapOptions = {
        center: new google.maps.LatLng(latitude, longitude),
        zoom: 15,
        mapTypeId: google.maps.MapTypeId.ROADMAP
    };
    Map = new google.maps.Map(document.getElementById("places"), mapOptions);
    Infowindow = new google.maps.InfoWindow();
    var service = new google.maps.places.PlacesService(Map);
    service.nearbySearch({
        location: latLong,
        radius: 500,
        type: ['store']
    }, foundStoresCallback);
}
// Success callback for watching your changing position
var onPlacesWatchSuccess = function (position) {
    var updatedLatitude = position.coords.latitude;
    var updatedLongitude = position.coords.longitude;
    if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
        Latitude = updatedLatitude;
        Longitude = updatedLongitude;
        getPlaces(updatedLatitude, updatedLongitude);
    }
}
// Success callback for locating stores in the area
function foundStoresCallback(results, status) {
    if (status === google.maps.places.PlacesServiceStatus.OK) {
        for (var i = 0; i < results.length; i++) {
            createMarker(results[i]);
        }
    }
}
// Place a pin for each store on the map
function createMarker(place) {
    var placeLoc = place.geometry.location;
    var marker = new google.maps.Marker({
        map: Map,
        position: place.geometry.location
    });
    google.maps.event.addListener(marker, 'click', function () {
        Infowindow.setContent(place.name);
        Infowindow.open(Map, this);
    });
}
// Error callback
function onPlacesError(error) {
    console.log('code: ' + error.code + '\n' +
        'message: ' + error.message + '\n');
}
// Watch your changing position
function watchPlacesPosition() {
    return navigator.geolocation.watchPosition
    (onPlacesWatchSuccess, onPlacesError, { enableHighAccuracy: true });
}‎

مطالعة صور الأشياء المحيطة بك

يمكن أن تحتوي الصور الرقمية على إحداثيات جغرافية تحدد مكان التقاط الصورة.

استخدم الواجهة البرمجية لموقع Flickr للعثور على الصور التي التُقِطت بالقرب من مكان تواجدك. مثل خدمات جوجل، ستحتاج إلى مفتاح، ولكنه مجاني إن كنت ترغب في التجربة وحسب.

var Latitude = undefined;
var Longitude = undefined;
// Get geo coordinates
function getPicturesLocation() {
    navigator.geolocation.getCurrentPosition
    (onPicturesSuccess, onPicturesError, { enableHighAccuracy: true });
}
// Success callback for get geo coordinates
var onPicturesSuccess = function (position) {
    Latitude = position.coords.latitude;
    Longitude = position.coords.longitude;
    getPictures(Latitude, Longitude);
}
// Get pictures by using coordinates
function getPictures(latitude, longitude) {
    $('#pictures').empty();
    var queryString =
    "https://api.flickr.com/services/rest/?method=flickr.photos.search&api_key=Your_API_Key&lat="
    + latitude + "&lon=" + longitude + "&format=json&jsoncallback=?";
    $.getJSON(queryString, function (results) {
        $.each(results.photos.photo, function (index, item) {
            var photoURL = "http://farm" + item.farm + ".static.flickr.com/" +
                item.server + "/" + item.id + "_" + item.secret + "_m.jpg";
            $('#pictures').append($("<img />").attr("src", photoURL));
           });
        }
    );
}
// Success callback for watching your changing position
var onPicturesWatchSuccess = function (position) {
    var updatedLatitude = position.coords.latitude;
    var updatedLongitude = position.coords.longitude;
    if (updatedLatitude != Latitude && updatedLongitude != Longitude) {
        Latitude = updatedLatitude;
        Longitude = updatedLongitude;
        getPictures(updatedLatitude, updatedLongitude);
    }
}
// Error callback
function onPicturesError(error) {
    console.log('code: ' + error.code + '\n' +
        'message: ' + error.message + '\n');
}
// Watch your changing position
function watchPicturePosition() {
    return navigator.geolocation.watchPosition
    (onPicturesWatchSuccess, onPicturesError, { enableHighAccuracy: true });
}‎

مصادر

• صفحة cordova-plugin-geolocation في توثيق كوردوفا الرسمي.