Represents information about a system user. More...

#include <IVxUser.h>

Public Member Functions
virtual VxResult::Value	AddToRole (IVxRole &role) const =0
	Adds a role to this user. More...

virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteUser () const =0
	Deletes this user from the VideoXpert system. More...

virtual VxResult::Value	GetAccountState (bool &isEnabled) const =0
	Gets the account state of the user. More...

virtual VxResult::Value	GetDataObjects (VxCollection< IVxDataObject ** > &dataObjectCollection) const =0
	Gets the data objects associated with this user. More...

virtual VxResult::Value	GetRoles (VxCollection< IVxRole ** > &roleCollection) const =0
	Gets the roles associated with this user. More...

virtual VxResult::Value	GetTags (VxCollection< IVxTag ** > &tagCollection) const =0
	Gets all private tags owned by this user and all public tags. Other user�s private tags will not be returned regardless of permissions. More...

virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...

virtual VxResult::Value	RemoveFromRole (IVxRole &role) const =0
	Removes a role from this user. More...

virtual VxResult::Value	SetAccountState (bool isEnabled) const =0
	Sets the account state of the user. A disabled account will not be able to access the system. More...

virtual VxResult::Value	SetDomain (char domain[64])=0
	Sets the domain property. More...

virtual VxResult::Value	SetEmployeeId (char employeeId[64])=0
	Sets the employee id property. More...

virtual VxResult::Value	SetFirstName (char firstName[64])=0
	Sets the first name property. More...

virtual VxResult::Value	SetLastName (char lastName[64])=0
	Sets the last name property. More...

virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...

virtual VxResult::Value	SetNote (char note[1024])=0
	Sets the note property. More...

virtual VxResult::Value	SetPassword (char newPassword[64]) const =0
	Sets a new password for the user. More...

virtual VxResult::Value	SetPhoneNumbers (VxPhoneNumber *phoneNumbers, int phoneNumberSize)=0
	Sets the telephone number(s) for this user. Maximum of 16 numbers. More...

Public Attributes
char	domain [64]
	The network domain for this user. More...

char	employeeId [64]
	The employee identifier associated with the user. More...

char	firstName [64]
	The first name of user. More...

char	id [64]
	The unique identifier of the user. More...

char	lastName [64]
	The last name of user. More...

char	name [64]
	The unique name, within the domain, of the user. More...

char	note [1024]
	Supplemental information about the user. More...

char	passwordExpiration [64]
	The time at which the user�s password will expire. More...

int	phoneNumberSize
	The size of phoneNumbers. More...

VxPhoneNumber *	phoneNumbers
	The telephone number(s) for the user. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents information about a system user.

Definition at line 16 of file IVxUser.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxUser::AddToRole ( IVxRole & role ) const

pure virtual

Adds a role to this user.

Parameters

role	The role to add the user to.

Returns: The Result of the request.

void VxSdk::IVxUser::Clear ( )

inlineprotected

Clears this instance.

Definition at line 174 of file IVxUser.h.

                      {
             VxZeroArray(this->domain);
             VxZeroArray(this->employeeId);
             VxZeroArray(this->firstName);
             VxZeroArray(this->id);
             VxZeroArray(this->lastName);
             VxZeroArray(this->name);
             VxZeroArray(this->note);
             VxZeroArray(this->passwordExpiration);
             this->phoneNumberSize = 0;
             this->phoneNumbers = nullptr;
         }

virtual VxResult::Value VxSdk::IVxUser::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxUser::DeleteUser ( ) const

pure virtual

Deletes this user from the VideoXpert system.

Returns: The Result of deleting this user.

virtual VxResult::Value VxSdk::IVxUser::GetAccountState ( bool & isEnabled ) const

pure virtual

Gets the account state of the user.

Parameters

isEnabled True if the user account is enabled, false if disabled.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxUser::GetDataObjects ( VxCollection< IVxDataObject ** > & dataObjectCollection ) const

pure virtual

Gets the data objects associated with this user.

Available filters: kClientType, kModifiedSince, kOwned, kOwner.

Parameters

dataObjectCollection A VxCollection of data objects associated with this user.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxUser::GetRoles ( VxCollection< IVxRole ** > & roleCollection ) const

pure virtual

Gets the roles associated with this user.

Available filters: kId, kInternal, kModifiedSince, kName.

Parameters

roleCollection The roles associated with this user.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxUser::GetTags ( VxCollection< IVxTag ** > & tagCollection ) const

pure virtual

Gets all private tags owned by this user and all public tags. Other user�s private tags will not be returned regardless of permissions.

Available filters: kId, kModifiedSince, kName, kOwned, kOwner, kResourceId, kResourceType.

Parameters

tagCollection A VxCollection of tags available to the user.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxUser::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns: The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxUser::RemoveFromRole ( IVxRole & role ) const

pure virtual

Removes a role from this user.

Parameters

role	The role to remove the user from.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxUser::SetAccountState ( bool isEnabled ) const

pure virtual

Sets the account state of the user. A disabled account will not be able to access the system.

Parameters

isEnabled True to enable the user account, false to disable.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxUser::SetDomain ( char domain[64] )

pure virtual

Sets the domain property.

Parameters

domain The new domain value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxUser::SetEmployeeId ( char employeeId[64] )

pure virtual

Sets the employee id property.

Parameters

employeeId The new employee id value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxUser::SetFirstName ( char firstName[64] )

pure virtual

Sets the first name property.

Parameters

firstName The new first name value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxUser::SetLastName ( char lastName[64] )

pure virtual

Sets the last name property.

Parameters

lastName The new last name value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxUser::SetName ( char name[64] )

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxUser::SetNote ( char note[1024] )

pure virtual

Sets the note property.

Parameters

note	The new note value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxUser::SetPassword ( char newPassword[64] ) const

pure virtual

Sets a new password for the user.

Parameters

newPassword The new password to set for this user.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxUser::SetPhoneNumbers	(	VxPhoneNumber *	phoneNumbers,
		int	phoneNumberSize
	)

pure virtual

Sets the telephone number(s) for this user. Maximum of 16 numbers.

Parameters

phoneNumbers	The phone numbers.
phoneNumberSize	The size of phoneNumbers.

Returns: The Result of setting the property.

Member Data Documentation

char VxSdk::IVxUser::domain[64]

The network domain for this user.

Definition at line 132 of file IVxUser.h.

char VxSdk::IVxUser::employeeId[64]

The employee identifier associated with the user.

Definition at line 136 of file IVxUser.h.

char VxSdk::IVxUser::firstName[64]

The first name of user.

Definition at line 140 of file IVxUser.h.

char VxSdk::IVxUser::id[64]

The unique identifier of the user.

Definition at line 144 of file IVxUser.h.

char VxSdk::IVxUser::lastName[64]

The last name of user.

Definition at line 148 of file IVxUser.h.

char VxSdk::IVxUser::name[64]

The unique name, within the domain, of the user.

Definition at line 152 of file IVxUser.h.

char VxSdk::IVxUser::note[1024]

Supplemental information about the user.

Definition at line 156 of file IVxUser.h.

char VxSdk::IVxUser::passwordExpiration[64]

The time at which the user�s password will expire.

Definition at line 160 of file IVxUser.h.

VxPhoneNumber* VxSdk::IVxUser::phoneNumbers

The telephone number(s) for the user.

Definition at line 168 of file IVxUser.h.

int VxSdk::IVxUser::phoneNumberSize

The size of phoneNumbers.

Definition at line 164 of file IVxUser.h.

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

C:/Git/VXSDK_M3/VxSdk/Include/IVxUser.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation