VxSdk::IVxNotification Struct Reference

Represents a particular notification configuration for a situation. More...

#include <IVxNotification.h>

Public Member Functions
virtual VxResult::Value	AddRole (IVxRole &role) const =0
	Adds a role to the list of roles that this notification serves. More...
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	DeleteNotification () const =0
	Delete this Notification from the VideoXpert system. More...
virtual VxResult::Value	GetRoles (VxCollection< IVxRole ** > &roleCollection) const =0
	Gets the roles that will receive this notification. 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	RemoveRole (IVxRole &role)=0
	Remmoves a role from the list of roles that this notification serves. More...

Public Attributes
char	id [64]
	The unique identifier of the notification. More...
char **	roleIds
	The ids for each role that should receive this notification. More...
int	roleIdSize
	The size of roleIds. More...

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

Detailed Description

Represents a particular notification configuration for a situation.

Definition at line 15 of file IVxNotification.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxNotification::AddRole ( IVxRole &  role ) const

pure virtual

Adds a role to the list of roles that this notification serves.

Parameters

role	The role to add.

Returns

The Result of adding the role.

void VxSdk::IVxNotification::Clear ( )

inlineprotected

Clears this instance.

Definition at line 70 of file IVxNotification.h.

                     {
            VxZeroArray(this->id);
            this->roleIds = nullptr;
            this->roleIdSize = 0;
        }

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

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxNotification::DeleteNotification ( ) const

pure virtual

Delete this Notification from the VideoXpert system.

Returns

The Result of deleting the Notification.

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

pure virtual

Gets the roles that will receive this notification.

Available filters: kId, kInternal, kModifiedSince, kName.

Parameters

roleCollection

The roles that will receive this notification.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxNotification::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::IVxNotification::RemoveRole ( IVxRole &  role )

pure virtual

Remmoves a role from the list of roles that this notification serves.

Parameters

role	The role to remove.

Returns

The Result of removing the role.

Member Data Documentation

char VxSdk::IVxNotification::id[64]

The unique identifier of the notification.

Definition at line 56 of file IVxNotification.h.

char** VxSdk::IVxNotification::roleIds

The ids for each role that should receive this notification.

Definition at line 60 of file IVxNotification.h.

int VxSdk::IVxNotification::roleIdSize

The size of roleIds.

Definition at line 64 of file IVxNotification.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/IVxNotification.h