FAQ

Location Sync

Published: May 19, 2020
Edited: May 21, 2020

Location Sync Plugin

Version: 1.0

Status:

LocationSync plugin for Thunder framework.

Table of Contents

Introduction

Scope

This document describes purpose and functionality of the LocationSync plugin. It includes detailed specification of its configuration, methods and properties provided, as well as notifications sent.

Case Sensitivity

All identifiers on the interface described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.

Acronyms, Abbreviations and Terms

The table below provides and overview of acronyms used in this document and their definitions.

Acronym Description
API Application Programming Interface
HTTP Hypertext Transfer Protocol
JSON JavaScript Object Notation; a data interchange format
JSON-RPC A remote procedure call protocol encoded in JSON

The table below provides and overview of terms and abbreviations used in this document and their definitions.

Term Description
callsign The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique.

References

Ref ID Description
HTTP HTTP specification
JSON-RPC JSON-RPC 2.0 specification
JSON JSON specification
Thunder Thunder API Reference

Description

The LocationSync plugin provides geo-location functionality.

The plugin is designed to be loaded and executed within the Thunder framework. For more information about the framework refer to [Thunder].

Configuration

The table below lists configuration options of the plugin.

Name Type Description
callsign string Plugin instance name (default: LocationSync)
classname string Class name: LocationSync
locator string Library name: libWPELocationSync.so
autostart boolean Determines if the plugin is to be started automatically along with the framework

Methods

The following methods are provided by the LocationSync plugin:

LocationSync interface methods:

Method Description
sync Synchronizes the location

sync method

Synchronizes the location.

Parameters

This method takes no parameters.

Result

Name Type Description
result null Always null

Errors

Code Message Description
1 ERROR_GENERAL Failed to synchdonize the location
2 ERROR_UNAVAILABLE Unavailable locator
15 ERROR_INCORRECT_URL Incorrect URL
12 ERROR_INPROGRESS Probing in progress

Example

Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "LocationSync.1.sync"
}

Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": null
}

Properties

The following properties are provided by the LocationSync plugin:

LocationSync interface properties:

Property Description
location RO Location information

location property

Provides access to the location information.

This property is read-only.

Value

Name Type Description
(property) object Location information
(property).city string City name
(property).country string Country name
(property).region string Region name
(property).timezone string Time zone information
(property).publicip string Public IP

Example

Get Request

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "method": "LocationSync.1.location"
}

Get Response

{
    "jsonrpc": "2.0",
    "id": 1234567890,
    "result": {
        "city": "Wroclaw",
        "country": "Poland",
        "region": "Wroclaw",
        "timezone": "CET-1CEST,M3.5.0,M10.5.0/3",
        "publicip": "78.11.117.118"
    }
}

Notifications

Notifications are autonomous events, triggered by the internals of the plugin, and broadcasted via JSON-RPC to all registered observers. Refer to [Thunder] for information on how to register for a notification.

The following events are provided by the LocationSync plugin:

LocationSync interface events:

Event Description
locationchange Signals a location change

locationchange event

Signals a location change.

Parameters

This event carries no parameters.

Example

{
    "jsonrpc": "2.0",
    "method": "client.events.1.locationchange"
}
PHP Code Snippets Powered By : XYZScripts.com