BdsApi  2.0.11
Public Member Functions | Public Attributes | List of all members
Bds::User Class Reference

This holds information on a user. More...

#include <BdsD.h>

Inheritance diagram for Bds::User:

Public Member Functions

 User (BUInt32 pid=0, BString puser=BString(), BString ppassword=BString(), BString pname=BString(), BString pemail=BString(), BString ptelephone=BString(), BString paddress=BString(), BInt32 penabled=0, BList< BString > pgroups=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 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< BString > groups
 The security groups the user belongs to. More...
 

Detailed Description

This holds information on a user.

Constructor & Destructor Documentation

◆ User()

Bds::User::User ( BUInt32  pid = 0,
BString  puser = BString(),
BString  ppassword = BString(),
BString  pname = BString(),
BString  pemail = BString(),
BString  ptelephone = BString(),
BString  paddress = BString(),
BInt32  penabled = 0,
BList< BString >  pgroups = BList<BString >() 
)

Member Function Documentation

◆ getMember()

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

◆ getMembers()

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

◆ getType()

BString Bds::User::getType ( )

◆ setMember()

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

◆ setMembers()

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

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: