CPPCli::Notification Class Reference

The Notification class represents a particular notification configuration for a situation. More...

#include <Notification.h>

Public Member Functions
	Notification (VxSdk::IVxNotification *vxNotification)
	Constructor. More...
virtual	~Notification ()
	Destructor. More...
	!Notification ()
	Finaliser. More...
CPPCli::Results::Value	AddRole (Role^ role)
	Add a role to the list of roles that this notification serves. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...
CPPCli::Results::Value	RemoveRole (Role^ role)
	Remove a role from the list of roles that this notification serves. More...

Package Functions
System::Collections::Generic::List< Role^ >^	_GetRoles ()

Package Attributes
VxSdk::IVxNotification *	_notification

Properties
System::String^	Id [get]
	Gets the unique notification identifier. More...
System::Collections::Generic::List< Role^ >^	Roles [get]
	Gets the roles that this notification serves. More...

Detailed Description

The Notification class represents a particular notification configuration for a situation.

Definition at line 14 of file Notification.h.

Constructor & Destructor Documentation

CPPCli::Notification::Notification

(

VxSdk::IVxNotification *

vxNotification

)

Constructor.

Parameters

vxNotification

The vx notification.

Definition at line 8 of file Notification.cpp.

                                                                     {
    _notification = vxNotification;
}

virtual CPPCli::Notification::~Notification ( )

inlinevirtual

Destructor.

Definition at line 26 of file Notification.h.

                                {
            this->!Notification();
        }

CPPCli::Notification::!Notification

(

)

Finaliser.

Definition at line 12 of file Notification.cpp.

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

Member Function Documentation

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

package

Definition at line 35 of file Notification.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 = _notification->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 = _notification->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;
}

CPPCli::Results::Value CPPCli::Notification::AddRole

(

CPPCli::Role^

role

)

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

Parameters

role	The role to add to this notification.

Returns

The Result of adding the role.

Definition at line 17 of file Notification.cpp.

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

CPPCli::Results::Value CPPCli::Notification::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 24 of file Notification.cpp.

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

CPPCli::Results::Value CPPCli::Notification::RemoveRole

(

CPPCli::Role^

role

)

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

Parameters

role	The role to remove from this notification.

Returns

The Result of removing the role.

Definition at line 28 of file Notification.cpp.

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

Member Data Documentation

VxSdk::IVxNotification* CPPCli::Notification::_notification

package

Definition at line 74 of file Notification.h.

Property Documentation

System:: String^ CPPCli::Notification::Id

get

Gets the unique notification identifier.

The unique identifier.

Definition at line 59 of file Notification.h.

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

get

Gets the roles that this notification serves.

A list of roles.

Definition at line 68 of file Notification.h.

---

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

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