RobotLib  1
A set of software wrappers for Rovio, Roomba and NXT robots written in C#.
 All Classes Namespaces Functions Variables Enumerations Properties Pages
Public Member Functions | List of all members
Rovio.API.User Class Reference

Manage user accounts. More...

Inheritance diagram for Rovio.API.User:
Rovio.Component

Public Member Functions

 User (Robot _robot)
 The constructor.
 
string GetMyself (bool show_privilege)
 Get the username who sent this HTTP request.
 
void SetUser (string name, string password)
 Add a user or change the password for the existing user.
 
void DeleteUser (string name)
 Delete a user account.
 
string GetUser (bool show_privilege)
 Get the users list.
 
void SetUserCheck (bool value)
 Enable or disable user authorization check.
 
- Public Member Functions inherited from Rovio.Component
 Component (Robot _robot)
 The constructor.
 
virtual void Update ()
 The Update function that manually refreshes the state of a given component (e.g. when AutoUpdate = false)
 

Additional Inherited Members

- Public Attributes inherited from Rovio.Component
bool AutoUpdate = true
 Automatic update option for methods requesting more than one piece of information.
 
- Protected Attributes inherited from Rovio.Component
Robot robot
 The robot class, accessible by all dervied classes.
 

Detailed Description

Manage user accounts.

Constructor & Destructor Documentation

Rovio.API.User.User ( Robot  _robot)

The constructor.

Member Function Documentation

void Rovio.API.User.DeleteUser ( string  name)

Delete a user account.

string Rovio.API.User.GetMyself ( bool  show_privilege)

Get the username who sent this HTTP request.

Todo:
Implement the proper return value: list of strings.
string Rovio.API.User.GetUser ( bool  show_privilege)

Get the users list.

Todo:
Implement the proper return value: list of strings.
void Rovio.API.User.SetUser ( string  name,
string  password 
)

Add a user or change the password for the existing user.

void Rovio.API.User.SetUserCheck ( bool  value)

Enable or disable user authorization check.


The documentation for this class was generated from the following file: