CPPCli::User Class Reference

The User class represents information about a system user. More...

#include <User.h>

Public Types
enum	PhoneType {   PhoneType::Home,   PhoneType::HomeFax,   PhoneType::Mobile,   PhoneType::Other,   PhoneType::Pager,   PhoneType::Work,   PhoneType::WorkFax }
	Values that represent the type of a phone number. More...

Public Member Functions
	User (VxSdk::IVxUser *vxUser)
	Constructor. More...
virtual	~User ()
	Destructor. More...
	!User ()
	Finaliser. More...
CPPCli::Results::Value	AddToRole (CPPCli::Role^ role)
	Add this user to a role. More...
Results::Value	Refresh ()
	Update this instances properties. More...
CPPCli::Results::Value	RemoveFromRole (CPPCli::Role^ role)
	Remove this user from a role. More...
CPPCli::Results::Value	SetPassword (System::String^ newPassword)
	Submit a request for a password change. More...

Package Functions
bool	_GetAccountState ()
System::Collections::Generic::List< DataObject^ >^	_GetDataObjects ()
System::Collections::Generic::List< Role^ >^	_GetRoles ()
System::Collections::Generic::List< Tag^ >^	_GetTags ()

Package Attributes
VxSdk::IVxUser *	_user

Properties
bool	AccountState [get, set]
	Gets or sets the state of the user account, either enabled or disabled. More...
System::Collections::Generic::List< DataObject^ >^	DataObjects [get]
	Gets all private data objects owned by this user and all public data objects. Other user’s private data objects will not be returned. More...
System::String^	Domain [get, set]
	Gets or sets the network domain for this user. More...
System::String^	EmployeeId [get, set]
	Gets or sets the employee identifier associated with the user. More...
System::String^	FirstName [get, set]
	Gets or sets the first name of user. More...
System::String^	Id [get]
	Gets the unique identifier of the user. More...
System::String^	LastName [get, set]
	Gets or sets the last name of user. More...
System::String^	Name [get, set]
	Gets or sets the friendly name, within the domain, of the user. More...
System::String^	Note [get, set]
	Gets or sets supplemental information about the user. More...
System::DateTime	PasswordExpiration [get]
	Gets the time at which the user’s password will expire. More...
System::Collections::Generic::List< System::Collections::Generic::KeyValuePair< User::PhoneType, System::String^ >>^	PhoneNumbers [get, set]
	Gets or sets the telephone number(s) for the user. More...
System::Collections::Generic::List< Role^ >^	Roles [get]
	Gets the roles currently assigned to this user. More...
System::Collections::Generic::List< Tag^ >^	Tags [get]
	Gets the tags currently assigned to this user. More...

Detailed Description

The User class represents information about a system user.

Definition at line 16 of file User.h.

Member Enumeration Documentation

enum CPPCli::User::PhoneType

strong

Values that represent the type of a phone number.

Enumerator
Home	Home number.
HomeFax	Home fax number.
Mobile	Mobile number.
Other	Other number.
Pager	Pager number.
Work	Work number.
WorkFax	Work fax number.

Definition at line 22 of file User.h.

                             {
            Home,

            HomeFax,

            Mobile,

            Other,

            Pager,

            Work,

            WorkFax
        };

Constructor & Destructor Documentation

CPPCli::User::User

(

VxSdk::IVxUser *

vxUser

)

Constructor.

Parameters

vxUser

The vx user.

Definition at line 9 of file User.cpp.

                                     {
    _user = vxUser;
}

virtual CPPCli::User::~User ( )

inlinevirtual

Destructor.

Definition at line 54 of file User.h.

                        {
            this->!User();
        }

CPPCli::User::!User

(

)

Finaliser.

Definition at line 13 of file User.cpp.

                  {
    _user->Delete();
    _user = nullptr;
}

Member Function Documentation

bool CPPCli::User::_GetAccountState ( )

package

Definition at line 46 of file User.cpp.

                                  {
    // Get and return the account state
    bool state;
    _user->GetAccountState(state);
    return state;
}

System::Collections::Generic::List< CPPCli::DataObject^ > CPPCli::User::_GetDataObjects ( )

package

Definition at line 53 of file User.cpp.

                                                                             {
    // Create a list of managed data objects
    List<DataObject^>^ mlist = gcnew List<DataObject^>();
    // Create a collection of unmanaged data objects
    VxSdk::VxCollection<VxSdk::IVxDataObject**> dataObjects;

    // Make the GetDataObjects call, which will return with the total data object count, this allows the
    // client to allocate memory.
    VxSdk::VxResult::Value result = _user->GetDataObjects(dataObjects);
    // As long as there are data objects linked the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxDataObject collection
        dataObjects.collection = new VxSdk::IVxDataObject*[dataObjects.collectionSize];
        result = _user->GetDataObjects(dataObjects);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < dataObjects.collectionSize; i++)
                mlist->Add(gcnew DataObject(dataObjects.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] dataObjects.collection;
    }
    return mlist;
}

System::Collections::Generic::List< CPPCli::Role^ > CPPCli::User::_GetRoles ( )

package

Definition at line 78 of file User.cpp.

                                                                 {
    // Create a list of managed roles
    List<Role^>^ mlist = gcnew List<Role^>();
    // Create a collection of unmanaged roles
    VxSdk::VxCollection<VxSdk::IVxRole**> roles;

    // Make the GetRoles call, which will return with the total role count, this
    // allows the client to allocate memory.
    VxSdk::VxResult::Value result = _user->GetRoles(roles);
    // As long as there are roles linked the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxRole collection
        roles.collection = new VxSdk::IVxRole*[roles.collectionSize];
        result = _user->GetRoles(roles);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < roles.collectionSize; i++)
                mlist->Add(gcnew Role(roles.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] roles.collection;
    }
    return mlist;
}

System::Collections::Generic::List< CPPCli::Tag^ > CPPCli::User::_GetTags ( )

package

Definition at line 103 of file User.cpp.

                                                               {
    // Create a list of managed tags
    List<Tag^>^ mlist = gcnew List<Tag^>();
    // Create a collection of unmanaged tags
    VxSdk::VxCollection<VxSdk::IVxTag**> tags;

    // Make the GetTags call, which will return with the total tag count, this
    // allows the client to allocate memory.
    VxSdk::VxResult::Value result = _user->GetTags(tags);
    // As long as there are tags linked the result should be VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // Allocate enough space for the IVxTag collection
        tags.collection = new VxSdk::IVxTag*[tags.collectionSize];
        result = _user->GetTags(tags);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < tags.collectionSize; i++)
                mlist->Add(gcnew Tag(tags.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] tags.collection;
    }
    return mlist;
}

CPPCli::Results::Value CPPCli::User::AddToRole

(

CPPCli::Role^

role

)

Add this user to a role.

Parameters

role	The role to add this user to.

Returns

The Result of adding the user.

Definition at line 18 of file User.cpp.

                                                         {
    // Make the call to add the user to the role
    VxSdk::VxResult::Value result = _user->AddToRole(*role->_role);
    // Unless there was an issue adding the user the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

CPPCli::Results::Value CPPCli::User::Refresh

(

)

Update this instances properties.

Returns

The Result of updating the properties.

Definition at line 25 of file User.cpp.

                                       {
    return (CPPCli::Results::Value)_user->Refresh();
}

CPPCli::Results::Value CPPCli::User::RemoveFromRole

(

CPPCli::Role^

role

)

Remove this user from a role.

Parameters

role	The role to remove this user from.

Returns

The Result of removing the user.

Definition at line 29 of file User.cpp.

                                                              {
    // Make the call to remove the user from the role
    VxSdk::VxResult::Value result = _user->RemoveFromRole(*role->_role);
    // Unless there was an issue removing the user from the role the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

CPPCli::Results::Value CPPCli::User::SetPassword

(

System::String^

newPassword

)

Submit a request for a password change.

Parameters

newPassword

The new password.

Returns

The Result of setting the password.

Definition at line 36 of file User.cpp.

                                                                    {
    char password[64];
    VxSdk::Utilities::StrCopySafe(password, Utils::ConvertSysStringNonConst(newPassword));

    // Make the call to set the users password
    VxSdk::VxResult::Value result = _user->SetPassword(password);
    // Unless there was an issue setting the password the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

Member Data Documentation

VxSdk::IVxUser* CPPCli::User::_user

package

Definition at line 264 of file User.h.

Property Documentation

bool CPPCli::User::AccountState

getset

Gets or sets the state of the user account, either enabled or disabled.

The state of the user account.

Definition at line 94 of file User.h.

System:: Collections:: Generic:: List< DataObject^>^ CPPCli::User::DataObjects

get

Gets all private data objects owned by this user and all public data objects. Other user’s private data objects will not be returned.

A list of data objects.

Definition at line 105 of file User.h.

System:: String^ CPPCli::User::Domain

getset

Gets or sets the network domain for this user.

The network domain.

Definition at line 114 of file User.h.

System:: String^ CPPCli::User::EmployeeId

getset

Gets or sets the employee identifier associated with the user.

The employee identifier.

Definition at line 128 of file User.h.

System:: String^ CPPCli::User::FirstName

getset

Gets or sets the first name of user.

The first name of user.

Definition at line 142 of file User.h.

System:: String^ CPPCli::User::Id

get

Gets the unique identifier of the user.

The unique identifier.

Definition at line 156 of file User.h.

System:: String^ CPPCli::User::LastName

getset

Gets or sets the last name of user.

The last name of user.

Definition at line 165 of file User.h.

System:: String^ CPPCli::User::Name

getset

Gets or sets the friendly name, within the domain, of the user.

The friendly name.

Definition at line 179 of file User.h.

System:: String^ CPPCli::User::Note

getset

Gets or sets supplemental information about the user.

Information about the user.

Definition at line 193 of file User.h.

System:: DateTime CPPCli::User::PasswordExpiration

get

Gets the time at which the user’s password will expire.

The password experation date.

Definition at line 207 of file User.h.

System:: Collections:: Generic:: List< System:: Collections:: Generic:: KeyValuePair< User:: PhoneType, System:: String^>>^ CPPCli::User::PhoneNumbers

getset

Gets or sets the telephone number(s) for the user.

The telephone number(s) for the user.

Definition at line 216 of file User.h.

System:: Collections:: Generic:: List< Role^>^ CPPCli::User::Roles

get

Gets the roles currently assigned to this user.

A list of assigned roles.

Definition at line 249 of file User.h.

System:: Collections:: Generic:: List< Tag^>^ CPPCli::User::Tags

get

Gets the tags currently assigned to this user.

A list of assigned tags.

Definition at line 258 of file User.h.

---

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

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/User.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/User.cpp