BDS Public
BdsApi 4.0.1
This is the Blacknest BDS API.
Loading...
Searching...
No Matches

This holds information on a user. More...

#include <BdsD.h>

Inheritance diagram for Bds::User:
BObj

Public Member Functions

 User (BUInt32 id=0, BString user=BString(), BString password=BString(), BString name=BString(), BString email=BString(), BString telephone=BString(), BString address=BString(), BInt32 enabled=0, BList< BString > groups=BList< BString >())
 
const char * getType () const
 
BError setMembers (BDictString &members)
 
BError setMember (BString name, BString value)
 
BError getMembers (BDictString &members)
 
BError getMember (BString name, BString &value)
 
- Public Member Functions inherited from BObj
 BObj ()
 
virtual ~BObj ()
 
virtual const char * getType () const
 
virtual const BObjMembergetMembers () const
 
virtual BError getMembers (BDictString &members)
 
virtual BError getMember (BString name, BString &value)
 
virtual BError setMembers (BDictString &members)
 
virtual BError setMember (BString name, BString value)
 
virtual void membersPrint () const
 
virtual BString getDebugString ()
 

Public Attributes

BUInt32 id
 The unique user ID.
 
BString user
 The User ID.
 
BString password
 The User's password.
 
BString name
 The User's full name.
 
BString email
 The User's email Address.
 
BString telephone
 The User's telephone number.
 
BString address
 The User's postal address.
 
BInt32 enabled
 Whether the users account is enabled.
 
BList< BStringgroups
 The security groups the user belongs to.
 

Detailed Description

This holds information on a user.

All information on a BDS user is stored along with the security groups they belong to.

Constructor & Destructor Documentation

◆ User()

Bds::User::User ( BUInt32  id = 0,
BString  user = BString(),
BString  password = BString(),
BString  name = BString(),
BString  email = BString(),
BString  telephone = BString(),
BString  address = BString(),
BInt32  enabled = 0,
BList< BString groups = BList<BString >() 
)

Member Function Documentation

◆ getType()

const char * Bds::User::getType ( ) const
virtual

Reimplemented from BObj.

◆ setMembers()

BError Bds::User::setMembers ( BDictString members)
virtual

Reimplemented from BObj.

◆ setMember()

BError Bds::User::setMember ( BString  name,
BString  value 
)
virtual

Reimplemented from BObj.

◆ getMembers()

BError Bds::User::getMembers ( BDictString members)
virtual

Reimplemented from BObj.

◆ getMember()

BError Bds::User::getMember ( BString  name,
BString value 
)
virtual

Reimplemented from BObj.

Member Data Documentation

◆ id

BUInt32 Bds::User::id

The unique user ID.

◆ user

BString Bds::User::user

The User ID.

◆ password

BString Bds::User::password

The User's password.

◆ name

BString Bds::User::name

The User's full name.

◆ email

BString Bds::User::email

The User's email Address.

◆ telephone

BString Bds::User::telephone

The User's telephone number.

◆ address

BString Bds::User::address

The User's postal address.

◆ enabled

BInt32 Bds::User::enabled

Whether the users account is enabled.

◆ groups

BList<BString > Bds::User::groups

The security groups the user belongs to.


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