The NewSituation class represents a new situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected. More...

#include <NewSituation.h>

Public Member Functions
	NewSituation ()
	Default constructor. More...

	NewSituation (VxSdk::VxNewSituation *vxNewSituation)
	Constructor. More...

Package Attributes
VxSdk::VxNewSituation *	_newSituation

Properties
int	AudibleLoopDelay `[get, set]`
	Gets or sets the seconds to wait between audible notifications. More...

int	AudiblePlayCount `[get, set]`
	Gets or sets the amount of times to play audible notifications. More...

int	AutoAcknowledge `[get, set]`
	Gets or sets the number of seconds after which a generated event state will be set to AutoAcked. If less than 0, a generated event must be manually acknowledged. If 0, a generated event is set to AutoAcked immediately. More...

bool	IsAckNeeded `[get, set]`
	Gets or sets whether the generated events shall have an initial state of AckNeeded or NoAckNeeded. More...

System::String^	Name `[get, set]`
	Gets or sets the situation friendly name. More...

int	Severity `[get, set]`
	Gets or sets the severity of the generated event, from 1 (highest) to 10 (lowest). More...

bool	ShouldExpandBanner `[get, set]`
	Gets or sets whether the notification banner on clients should be expanded by default. More...

bool	ShouldLog `[get, set]`
	Gets or sets whether events generated from this situation shall be persisted or immediately be discarded. More...

bool	ShouldNotify `[get, set]`
	Gets or sets whether an event generated from the situation shall generate notifications. More...

System::Collections::Generic::List< int >^	SnoozeIntervals `[get, set]`
	Gets or sets the default snooze intervals, in seconds, for a generated event. More...

System::String^	SourceDeviceId `[get, set]`
	Gets or sets the unique source identifier. This field acts an optional constraint on the source of events for this situation. If specified, any events matching the situation type must also match this SourceDeviceId in order for the situation to apply. More...

System::String^	Type `[get, set]`
	Gets or sets situation type. The type must be of the form external/<company>/<event> where <company> and <event> are strings no greater than 64 characters each; forward slashes are not allowed. These strings describe the <company> that manufactured the device that was the source of the <event>. More...

bool	UseAudibleNotification `[get, set]`
	Gets or sets whether a notification sound should play on supporting clients when an event is received. More...

Detailed Description

The NewSituation class represents a new situation configuration that specifies how corresponding events shall be generated and handled when the situation is detected.

Definition at line 14 of file NewSituation.h.

Constructor & Destructor Documentation

CPPCli::NewSituation::NewSituation ( )

inline

Default constructor.

Definition at line 20 of file NewSituation.h.

                        {
             _newSituation = new VxSdk::VxNewSituation();
             _newSituation->Default();
         }

CPPCli::NewSituation::NewSituation ( VxSdk::VxNewSituation * vxNewSituation )

inline

Constructor.

Parameters

vxNewSituation The new situation.

Definition at line 29 of file NewSituation.h.

                                                           {
             _newSituation = vxNewSituation;
         }

Member Data Documentation

VxSdk::VxNewSituation* CPPCli::NewSituation::_newSituation

package

Definition at line 184 of file NewSituation.h.

Property Documentation

int CPPCli::NewSituation::AudibleLoopDelay

getset

Gets or sets the seconds to wait between audible notifications.

The seconds between audible notifications.

Definition at line 37 of file NewSituation.h.

int CPPCli::NewSituation::AudiblePlayCount

getset

Gets or sets the amount of times to play audible notifications.

The amount of times to play audible notifications.

Definition at line 47 of file NewSituation.h.

int CPPCli::NewSituation::AutoAcknowledge

getset

Gets or sets the number of seconds after which a generated event state will be set to AutoAcked. If less than 0, a generated event must be manually acknowledged. If 0, a generated event is set to AutoAcked immediately.

The number of seconds before auto-acknowledgement.

Definition at line 58 of file NewSituation.h.

bool CPPCli::NewSituation::IsAckNeeded

getset

Gets or sets whether the generated events shall have an initial state of AckNeeded or NoAckNeeded.

true if events will require acknowledgement, false if not.

Definition at line 68 of file NewSituation.h.

System:: String^ CPPCli::NewSituation::Name

getset

Gets or sets the situation friendly name.

The friendly name.

Definition at line 78 of file NewSituation.h.

int CPPCli::NewSituation::Severity

getset

Gets or sets the severity of the generated event, from 1 (highest) to 10 (lowest).

The event severity.

Definition at line 88 of file NewSituation.h.

bool CPPCli::NewSituation::ShouldExpandBanner

getset

Gets or sets whether the notification banner on clients should be expanded by default.

true if the banner should be expanded, false if not.

Definition at line 98 of file NewSituation.h.

bool CPPCli::NewSituation::ShouldLog

getset

Gets or sets whether events generated from this situation shall be persisted or immediately be discarded.

true if events will be logged, false if not.

Definition at line 108 of file NewSituation.h.

bool CPPCli::NewSituation::ShouldNotify

getset

Gets or sets whether an event generated from the situation shall generate notifications.

true if notifications will be sent, false if not.

Definition at line 118 of file NewSituation.h.

System:: Collections:: Generic:: List< int>^ CPPCli::NewSituation::SnoozeIntervals

getset

Gets or sets the default snooze intervals, in seconds, for a generated event.

A List of snooze intervals in seconds.

Definition at line 128 of file NewSituation.h.

System:: String^ CPPCli::NewSituation::SourceDeviceId

getset

Gets or sets the unique source identifier. This field acts an optional constraint on the source of events for this situation. If specified, any events matching the situation type must also match this SourceDeviceId in order for the situation to apply.

The unique source identifier.

Definition at line 155 of file NewSituation.h.

System:: String^ CPPCli::NewSituation::Type

getset

Gets or sets situation type. The type must be of the form external/<company>/<event> where <company> and <event> are strings no greater than 64 characters each; forward slashes are not allowed. These strings describe the <company> that manufactured the device that was the source of the <event>.

The situation type.

Definition at line 167 of file NewSituation.h.

bool CPPCli::NewSituation::UseAudibleNotification

getset

Gets or sets whether a notification sound should play on supporting clients when an event is received.

true if audio should play on event notification, false if not.

Definition at line 177 of file NewSituation.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/NewSituation.h

Public Member Functions

Package Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation

Property Documentation