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

Class BlueViaUserContext

source code

BlueVia --+
          |
         BlueViaUserContext

The BlueVia class for retrieving information about user and terminal.

Instance Methods [hide private]
 
__init__(self, sandbox='_Sandbox', realm='BlueVia', version='v1')
Initialize the BlueViaUserContext object
source code
 
_getInfo(self, infoType, resultKey)
Internal method.
source code
 
getUserInfo(self)
Retrieve all available info about the user.
source code
 
getPersonalInfo(self)
Retrieve personal info about the user (depending on country, see www.bluevia.com)
source code
 
getProfileInfo(self)
Retrieve info about the user's profile (depending on country, see www.bluevia.com)
source code
 
getAccessInfo(self)
Retrieve info about the user's access type (depending on country, see www.bluevia.com)
source code
 
getTerminalInfo(self)
Retrieve info about the user's terminal (depending on country, see www.bluevia.com)
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 BlueViaUserContext 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"

getUserInfo(self)

source code 

Retrieve all available info about the user. Aggregates getPersonalInfo, getProfileInfo, getAccessInfo, getTerminalInfo

Returns:
(tuple): (HTTP status, (dict) userInfo). HTTP status == "200" for success.

getPersonalInfo(self)

source code 

Retrieve personal info about the user (depending on country, see www.bluevia.com)

Returns:
(tuple): (HTTP status, (dict) userPersonalInfo). HTTP status == "200" for success.

getProfileInfo(self)

source code 

Retrieve info about the user's profile (depending on country, see www.bluevia.com)

Returns:
(tuple): (HTTP status, (dict) userProfileInfo). HTTP status == "200" for success.

getAccessInfo(self)

source code 

Retrieve info about the user's access type (depending on country, see www.bluevia.com)

Returns:
(tuple): (HTTP status, (dict) userAccessInfo). HTTP status == "200" for success.

getTerminalInfo(self)

source code 

Retrieve info about the user's terminal (depending on country, see www.bluevia.com)

Returns:
(tuple): (HTTP status, (dict) userTerminalInfo). HTTP status == "200" for success.