The Privilege class represents a specific permission that is given to a role. More...

#include <Privilege.h>

Public Types
enum	PermissionIds { PermissionIds::Unknown, PermissionIds::ViewVideoSources, PermissionIds::UsePtzMode, PermissionIds::LockPtzMode, PermissionIds::CreateSystemBookmarks, PermissionIds::DeleteSystemBookmarks, PermissionIds::LaunchSavedViewsRemotely, PermissionIds::ViewRecordedVideo, PermissionIds::ExportMediaClips, PermissionIds::DeleteExports, PermissionIds::UseMap, PermissionIds::ViewMaps, PermissionIds::PlaceCamerasOnMap, PermissionIds::ManageMapFiles, PermissionIds::AccessUserViews, PermissionIds::ManageSystemViews, PermissionIds::AuditUserActivity, PermissionIds::ViewEventHistory, PermissionIds::HandleEvents, PermissionIds::ConfigureEvents, PermissionIds::ManageUserAccounts, PermissionIds::ManageAggregatorAccount, PermissionIds::AssignRolesToUsers, PermissionIds::ManageRoles, PermissionIds::ManageSystemTags, PermissionIds::SetupEdgeDevices, PermissionIds::ConfigureMonitorWallDecoders, PermissionIds::ConfigureRecording }

enum	ResourceTypes { ResourceTypes::Unknown, ResourceTypes::DataSource, ResourceTypes::Device, ResourceTypes::User }
	Values that represent a type of resource. More...

Public Member Functions
	Privilege (VxSdk::IVxPrivilege *vxPrivilege)
	Constructor. More...

virtual	~Privilege ()
	Destructor. More...

	!Privilege ()
	Finaliser. More...

CPPCli::Results::Value	Link (System::Collections::Generic::List< DataSource^ >^dataSources)
	Associate data sources with this privilege. More...

CPPCli::Results::Value	Link (System::Collections::Generic::List< Device^ >^devices)
	Associate devices with this privilege. More...

CPPCli::Results::Value	Link (System::Collections::Generic::List< User^ >^users)
	Associate users with this privilege. More...

Results::Value	Refresh ()
	Refreshes this instances properties. More...

CPPCli::Results::Value	Unlink (System::Collections::Generic::List< DataSource^ >^dataSources)
	Remove data source associations from this privilege. More...

CPPCli::Results::Value	Unlink (System::Collections::Generic::List< Device^ >^devices)
	Remove device associations from this privilege. More...

CPPCli::Results::Value	Unlink (System::Collections::Generic::List< User^ >^users)
	Remove user associations from this privilege. More...

Package Functions
System::Collections::Generic::List< DataSource^ >^	_GetLinkedDataSources ()

System::Collections::Generic::List< Device^ >^	_GetLinkedDevices ()

System::Collections::Generic::List< User^ >^	_GetLinkedUsers ()

int	_GetPriority ()

bool	_GetRestricted ()

System::Collections::Generic::List< DataSource^ >^	_GetUnLinkedDataSources ()

System::Collections::Generic::List< Device^ >^	_GetUnLinkedDevices ()

System::Collections::Generic::List< User^ >^	_GetUnLinkedUsers ()

Package Attributes
VxSdk::IVxPrivilege *	_privilege

Properties
bool	ExcludeRestricted `[get, set]`
	Gets or sets whether the privilege is excluded from the associated resources. More...

System::String^	Id `[get]`
	Gets the unique identifier for this privilege. More...

bool	IsRestricted `[get, set]`
	Gets or sets whether the privilege is restricted to the associated resources. More...

System::Collections::Generic::List< DataSource^ >^	LinkedDataSources `[get]`
	Gets the data sources associated with this privilege. More...

System::Collections::Generic::List< Device^ >^	LinkedDevices `[get]`
	Gets the devices associated with this privilege. More...

System::Collections::Generic::List< User^ >^	LinkedUsers `[get]`
	Gets the users associated with this privilege. More...

PermissionIds	PermissionId `[get]`
	Gets the identifier of the permission being granted by this privilege. More...

int	Priority `[get, set]`
	Gets or sets the relative priority for the privilege, from 1 to 250. Smaller numbers have higher priority than larger numbers (e.g. 1 is the highest priority). More...

ResourceTypes	ResourceType `[get]`
	Gets the resource type, if any, that can be linked to this privilege. More...

System::Collections::Generic::List< DataSource^ >^	UnLinkedDataSources `[get]`
	Gets the data sources not associated with this privilege. More...

System::Collections::Generic::List< Device^ >^	UnLinkedDevices `[get]`
	Gets the devices not associated with this privilege. More...

System::Collections::Generic::List< User^ >^	UnLinkedUsers `[get]`
	Gets the users not associated with this privilege. More...

Detailed Description

The Privilege class represents a specific permission that is given to a role.

Definition at line 15 of file Privilege.h.

Member Enumeration Documentation

enum CPPCli::Privilege::PermissionIds

strong

Enumerator
Unknown	An error or unknown value was returned.
ViewVideoSources	View video sources.
UsePtzMode	Use PTZ mode.
LockPtzMode	Lock PTZ mode.
CreateSystemBookmarks	Create system bookmarks.
DeleteSystemBookmarks	Delete system bookmarks.
LaunchSavedViewsRemotely	Launch saved views remotely.
ViewRecordedVideo	View recorded video.
ExportMediaClips	Export media clips.
DeleteExports	Delete exports.
UseMap	Use map.
ViewMaps	View maps.
PlaceCamerasOnMap	Place cameras on map.
ManageMapFiles	Manage map files.
AccessUserViews	Access user views.
ManageSystemViews	Manage system views.
AuditUserActivity	Audit user activity.
ViewEventHistory	View event history.
HandleEvents	Handle events.
ConfigureEvents	Configure events.
ManageUserAccounts	Manage user accounts.
ManageAggregatorAccount	Manage aggregator account.
AssignRolesToUsers	Assign roles to users.
ManageRoles	Manage roles.
ManageSystemTags	Manage system tags.
SetupEdgeDevices	Setup edge devices.
ConfigureMonitorWallDecoders	Configure monitor wall decoders.
ConfigureRecording	Configure recording.

Definition at line 17 of file Privilege.h.

                                   {
             Unknown,
 
             ViewVideoSources,
 
             UsePtzMode,
 
             LockPtzMode,
 
             CreateSystemBookmarks,
 
             DeleteSystemBookmarks,
 
             LaunchSavedViewsRemotely,
 
             ViewRecordedVideo,
 
             ExportMediaClips,
 
             DeleteExports,
 
             UseMap,
 
             ViewMaps,
 
             PlaceCamerasOnMap,
 
             ManageMapFiles,
 
             AccessUserViews,
 
             ManageSystemViews,
 
             AuditUserActivity,
 
             ViewEventHistory,
 
             HandleEvents,
 
             ConfigureEvents,
 
             ManageUserAccounts,
 
             ManageAggregatorAccount,
 
             AssignRolesToUsers,
 
             ManageRoles,
 
             ManageSystemTags,
 
             SetupEdgeDevices,
 
             ConfigureMonitorWallDecoders,
 
             ConfigureRecording
         };

enum CPPCli::Privilege::ResourceTypes

strong

Values that represent a type of resource.

Enumerator
Unknown	An error or unknown value was returned.
DataSource	A data source.
Device	A device.
User	A user.

Definition at line 106 of file Privilege.h.

                                  {
             Unknown,
             DataSource,
             Device,
             User
         };

Constructor & Destructor Documentation

CPPCli::Privilege::Privilege ( VxSdk::IVxPrivilege * vxPrivilege )

Constructor.

Parameters

vxPrivilege The vx privilege.

Definition at line 10 of file Privilege.cpp.

                                                          {
     _privilege = vxPrivilege;
 }

virtual CPPCli::Privilege::~Privilege ( )

inlinevirtual

Destructor.

Definition at line 126 of file Privilege.h.

                              {
             this->!Privilege();
         }

CPPCli::Privilege::!Privilege ( )

Finaliser.

Definition at line 14 of file Privilege.cpp.

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

Member Function Documentation

System::Collections::Generic::List< CPPCli::DataSource^ > CPPCli::Privilege::_GetLinkedDataSources ( )

package

Definition at line 101 of file Privilege.cpp.

                                                                                         {
     // Create a list of managed data sources
     List<CPPCli::DataSource^>^ mlist = gcnew List<CPPCli::DataSource^>();
     // Create a collection of unmanaged data sources
     VxSdk::VxCollection<VxSdk::IVxDataSource**> dataSources;
 
     // Make the GetLinks call, which will return with the total data source count, this
     // allows the client to allocate memory.
     VxSdk::VxResult::Value result = _privilege->GetLinks(dataSources);
     // As long as there are data sources linked the result should be VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for the IVxDataSource collection
         dataSources.collection = new VxSdk::IVxDataSource*[dataSources.collectionSize];
         result = _privilege->GetLinks(dataSources);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < dataSources.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::DataSource(dataSources.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] dataSources.collection;
     }
     return mlist;
 }

System::Collections::Generic::List< CPPCli::Device^ > CPPCli::Privilege::_GetLinkedDevices ( )

package

Definition at line 126 of file Privilege.cpp.

                                                                                 {
     // Create a list of managed devices
     List<CPPCli::Device^>^ mlist = gcnew List<CPPCli::Device^>();
     // Create a collection of unmanaged devices
     VxSdk::VxCollection<VxSdk::IVxDevice**> devices;
 
     // Make the GetLinks call, which will return with the total device count, this allows the
     // client to allocate memory.
     VxSdk::VxResult::Value result = _privilege->GetLinks(devices);
     // As long as there are devices linked the result should be VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for the IVxDevice collection
         devices.collection = new VxSdk::IVxDevice*[devices.collectionSize];
         result = _privilege->GetLinks(devices);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < devices.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::Device(devices.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] devices.collection;
     }
     return mlist;
 }

System::Collections::Generic::List< CPPCli::User^ > CPPCli::Privilege::_GetLinkedUsers ( )

package

Definition at line 151 of file Privilege.cpp.

                                                                             {
     // Create a list of managed users
     List<CPPCli::User^>^ mlist = gcnew List<CPPCli::User^>();
     // Create a collection of unmanaged users
     VxSdk::VxCollection<VxSdk::IVxUser**> users;
 
     // Make the GetLinks call, which will return with the total user count, this
     // allows the client to allocate memory.
     VxSdk::VxResult::Value result = _privilege->GetLinks(users);
     // As long as there are users linked the result should be VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for the IVxUser collection
         users.collection = new VxSdk::IVxUser*[users.collectionSize];
         result = _privilege->GetLinks(users);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < users.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::User(users.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] users.collection;
     }
     return mlist;
 }

int CPPCli::Privilege::_GetPriority ( )

package

Definition at line 176 of file Privilege.cpp.

                                   {
     // Get and return the priority
     int priority;
     _privilege->GetPriority(priority);
     return priority;
 }

bool CPPCli::Privilege::_GetRestricted ( )

package

Definition at line 183 of file Privilege.cpp.

                                      {
     // Get and return the restriction state
     bool isRestricted;
     _privilege->GetRestricted(isRestricted);
     return isRestricted;
 }

System::Collections::Generic::List< CPPCli::DataSource^ > CPPCli::Privilege::_GetUnLinkedDataSources ( )

package

Definition at line 190 of file Privilege.cpp.

                                                                                           {
     // Create a list of managed data sources
     List<CPPCli::DataSource^>^ mlist = gcnew List<CPPCli::DataSource^>();
     // Create a collection of unmanaged data sources
     VxSdk::VxCollection<VxSdk::IVxDataSource**> dataSources;
 
     // Make the GetUnLinked call, which will return with the total data source count, this
     // allows the client to allocate memory.
     VxSdk::VxResult::Value result = _privilege->GetUnLinked(dataSources);
     // As long as there are data sources linked the result should be VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for the IVxDataSource collection
         dataSources.collection = new VxSdk::IVxDataSource*[dataSources.collectionSize];
         result = _privilege->GetUnLinked(dataSources);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < dataSources.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::DataSource(dataSources.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] dataSources.collection;
     }
     return mlist;
 }

System::Collections::Generic::List< CPPCli::Device^ > CPPCli::Privilege::_GetUnLinkedDevices ( )

package

Definition at line 215 of file Privilege.cpp.

                                                                                   {
     // Create a list of managed devices
     List<CPPCli::Device^>^ mlist = gcnew List<CPPCli::Device^>();
     // Create a collection of unmanaged devices
     VxSdk::VxCollection<VxSdk::IVxDevice**> devices;
 
     // Make the GetUnLinked call, which will return with the total device count, this allows the
     // client to allocate memory.
     VxSdk::VxResult::Value result = _privilege->GetUnLinked(devices);
     // As long as there are devices linked the result should be VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for the IVxDevice collection
         devices.collection = new VxSdk::IVxDevice*[devices.collectionSize];
         result = _privilege->GetUnLinked(devices);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < devices.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::Device(devices.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] devices.collection;
     }
     return mlist;
 }

System::Collections::Generic::List< CPPCli::User^ > CPPCli::Privilege::_GetUnLinkedUsers ( )

package

Definition at line 240 of file Privilege.cpp.

                                                                               {
     // Create a list of managed users
     List<CPPCli::User^>^ mlist = gcnew List<CPPCli::User^>();
     // Create a collection of unmanaged users
     VxSdk::VxCollection<VxSdk::IVxUser**> users;
 
     // Make the GetUnLinked call, which will return with the total user count, this
     // allows the client to allocate memory.
     VxSdk::VxResult::Value result = _privilege->GetUnLinked(users);
     // As long as there are users linked the result should be VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Allocate enough space for the IVxUser collection
         users.collection = new VxSdk::IVxUser*[users.collectionSize];
         result = _privilege->GetUnLinked(users);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < users.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::User(users.collection[i]));
         }
         // Remove the memory we previously allocated to the collection
         delete[] users.collection;
     }
     return mlist;
 }

CPPCli::Results::Value CPPCli::Privilege::Link ( System::Collections::Generic::List< DataSource^ >^ dataSources )

Associate data sources with this privilege.

Parameters

dataSources A List containing the data sources to be added.

Returns: The Result of adding the data sources.

CPPCli::Results::Value CPPCli::Privilege::Link ( System::Collections::Generic::List< Device^ >^ devices )

Associate devices with this privilege.

Parameters

devices A List containing the devices to be added.

Returns: The Result of adding the devices.

CPPCli::Results::Value CPPCli::Privilege::Link ( System::Collections::Generic::List< User^ >^ users )

Associate users with this privilege.

Parameters

users A List containing the data sources to be added.

Returns: The Result of adding the data sources.

CPPCli::Results::Value CPPCli::Privilege::Refresh ( )

Refreshes this instances properties.

Returns: The Result of updating the properties.

Definition at line 58 of file Privilege.cpp.

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

CPPCli::Results::Value CPPCli::Privilege::Unlink ( System::Collections::Generic::List< DataSource^ >^ dataSources )

Remove data source associations from this privilege.

Parameters

dataSources A List containing the data sources to be removed.

Returns: The Result of removing the data sources.

CPPCli::Results::Value CPPCli::Privilege::Unlink ( System::Collections::Generic::List< Device^ >^ devices )

Remove device associations from this privilege.

Parameters

devices A List containing the devices to be removed.

Returns: The Result of removing the devices.

CPPCli::Results::Value CPPCli::Privilege::Unlink ( System::Collections::Generic::List< User^ >^ users )

Remove user associations from this privilege.

Parameters

users A List containing the users to be removed.

Returns: The Result of removing the users.

Member Data Documentation

VxSdk::IVxPrivilege* CPPCli::Privilege::_privilege

package

Definition at line 296 of file Privilege.h.

Property Documentation

bool CPPCli::Privilege::ExcludeRestricted

getset

Gets or sets whether the privilege is excluded from the associated resources.

true if the privilege is excluded, false if not.

Definition at line 187 of file Privilege.h.

System:: String^ CPPCli::Privilege::Id

get

Gets the unique identifier for this privilege.

The unique identifier.

Definition at line 197 of file Privilege.h.

bool CPPCli::Privilege::IsRestricted

getset

Gets or sets whether the privilege is restricted to the associated resources.

true if restricted, false if not.

Definition at line 206 of file Privilege.h.

System:: Collections:: Generic:: List< DataSource^>^ CPPCli::Privilege::LinkedDataSources

get

Gets the data sources associated with this privilege.

A list of data sources.

Definition at line 216 of file Privilege.h.

System:: Collections:: Generic:: List< Device^>^ CPPCli::Privilege::LinkedDevices

get

Gets the devices associated with this privilege.

A list of devices.

Definition at line 225 of file Privilege.h.

System:: Collections:: Generic:: List< User^>^ CPPCli::Privilege::LinkedUsers

get

Gets the users associated with this privilege.

A list of users.

Definition at line 234 of file Privilege.h.

PermissionIds CPPCli::Privilege::PermissionId

get

Gets the identifier of the permission being granted by this privilege.

The permission identifier.

Definition at line 243 of file Privilege.h.

int CPPCli::Privilege::Priority

getset

Gets or sets the relative priority for the privilege, from 1 to 250. Smaller numbers have higher priority than larger numbers (e.g. 1 is the highest priority).

The priority.

Definition at line 253 of file Privilege.h.

ResourceTypes CPPCli::Privilege::ResourceType

get

Gets the resource type, if any, that can be linked to this privilege.

The resource type.

Definition at line 263 of file Privilege.h.

System:: Collections:: Generic:: List< DataSource^>^ CPPCli::Privilege::UnLinkedDataSources

get

Gets the data sources not associated with this privilege.

A list of data sources.

Definition at line 272 of file Privilege.h.

System:: Collections:: Generic:: List< Device^>^ CPPCli::Privilege::UnLinkedDevices

get

Gets the devices not associated with this privilege.

A list of devices.

Definition at line 281 of file Privilege.h.

System:: Collections:: Generic:: List< User^>^ CPPCli::Privilege::UnLinkedUsers

get

Gets the users not associated with this privilege.

A list of users.

Definition at line 290 of file Privilege.h.

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

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

Public Types

Public Member Functions

Package Functions

Package Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation