BDS Public
BdsApi  2.0.11

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 >())
 
BString getType ()
 
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 void membersPrint () const
 
virtual BString getDebugString ()
 

Public Attributes

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

Detailed Description

This holds information on a user.

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

◆ getMember()

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

Reimplemented from BObj.

◆ getMembers()

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

Reimplemented from BObj.

◆ getType()

BString Bds::User::getType ( )

◆ setMember()

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

Reimplemented from BObj.

◆ setMembers()

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

Reimplemented from BObj.

Member Data Documentation

◆ address

BString Bds::User::address

The Users postal address.

◆ email

BString Bds::User::email

The users email 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.

◆ id

BUInt32 Bds::User::id

The unique user ID.

◆ name

BString Bds::User::name

The Users full name.

◆ password

BString Bds::User::password

The Users password.

◆ telephone

BString Bds::User::telephone

The Users telephone number.

◆ user

BString Bds::User::user

The User ID.


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