Module bluevia :: Class BlueViaLocation
[hide private]
[frames] | no frames]

Class BlueViaLocation

source code

BlueVia --+
          |
         BlueViaLocation

The BlueVia class for retrieving user's terminal cell location.

Instance Methods [hide private]
 
__init__(self, sandbox='_Sandbox', realm='BlueVia', version='v1')
Initialize the BlueViaLocation object
source code
 
locateTerminal(self, accuracy=None)
Retrieve the cell location of user's terminal (mobile device) including accuracy information
source code

Inherited from BlueVia: hasCredentials, loadAccessToken, setAccessToken, setConsumer, setDebug

Inherited from BlueVia (private): _debug, _signAndSend

Class Variables [hide private]

Inherited from BlueVia: access_token, consumer, debugFlag, environment, http, realm, version

Method Details [hide private]

__init__(self, sandbox='_Sandbox', realm='BlueVia', version='v1')
(Constructor)

source code 

Initialize the BlueViaLocation object

Parameters:
  • sandbox - (string): Indicates whether testing should be done in Sandbox mode. Use "" for real network access; Default: "_Sandbox"
  • realm - (string): Realm string; Default: "BlueVia"
  • version - (string): BlueVia API version; Default: "v1"

locateTerminal(self, accuracy=None)

source code 

Retrieve the cell location of user's terminal (mobile device) including accuracy information

Parameter:

Parameters:
  • accuracy - (int): Provide neccessary accurracy. Returns an error if accuracy requirements are not met.
Returns:
(tuple): (HTTP status, (dict) locationData). HTTP status == "200" for success.