account Class Reference

Static Public Member Functions
static	getOwnHiddenMeasurements ()
static	getOwnProfile ()
static	getOwnSettings ()
static	setOwnMeasurementHidden ()
static	setOwnMeasurementVisible ()
static	setOwnProfile ()
static	setOwnSettings ()

Detailed Description

This class lets your control various account information, such as the settings.

Member Function Documentation

static account::getOwnHiddenMeasurements ( )

static

Get the list of measurements hidden to the user.

Returns

An object such as:

Property	Type	Description
stationId	int	Station Id
measurements	array	An array of hidden measurements

The measurements are objects such as:

Property	Type	Description
measurementId	int	Measurement Id
slot	int	Id of the slot the sensor is installed on

static account::getOwnProfile ( )

static

Get the profile of the current user.

Returns

An object such as:

Property	Type	Description
email	string	The e-mail address the account is associated with
name	string	Full name
phone	string	Phone number
fax	string	Fax number
address	string	Postal address

static account::getOwnSettings ( )

static

Get the settings of the current user.

Returns

An object such as:

Property	Type	Description
language	string	The language (e.g., fr, en, de)
advancedMode	boolean	Whether the account is in advanced or in limited mode
announcements	boolean	Whether the user is subscribed to Climaps announcements
sortStationsBy	string	Criterion for sorting stations (e.g., id, name)

static account::setOwnMeasurementHidden ( )

static

Make a measurement hidden to the user.

Parameters

int	stationId	Station Id
int	measurementId	Measurement Id
int	slot	Id of the slot the sensor is installed on

Returns

An object such as:

Property	Type	Description
success	boolean	Whether hidden status could be saved
error	string	An error message in case of failure

static account::setOwnMeasurementVisible ( )

static

Make a measurement visible to the user.

Parameters

int	stationId	Station Id
int	measurementId	Measurement Id
int	slot	Id of the slot the sensor is installed on

Returns

An object such as:

Property	Type	Description
success	boolean	Whether hidden status could be saved
error	string	An error message in case of failure

static account::setOwnProfile ( )

static

Change the profile of the current user.

Parameters

string	fax	The fax number
string	phone	The phone number
string	name	The user's name
string	address	Postal address

Returns

An object such as:

Property	Type	Description
success	boolean	Whether profile information could be saved
error	string	An error message in case of failure

static account::setOwnSettings ( )

static

Change the settings of the current user.

Parameters

string	language	Language code: de, en, fr, it, or zh
string	advancedMode	Optional Whether the account is in advanced mode: true (default), or false
string	announcements	Optional Whether to receive announcements: true (default), or false
string	sortStationsBy	Optional Criterion for sorting stations: id, or name (default)

Returns

An object such as:

Property	Type	Description
success	boolean	Whether profile information could be saved
error	string	An error message in case of failure

Note

If the given language is not supported, it defaults to English.