VideoOS.Platform.Messaging.MessageId.Server Class Reference

This class is a collection of static strings for server communications. The event and alarm messages will be sent to the EventServer and others represent communication to the logon server.
More...

Static Public Attributes
const string	AlarmNotificationsDisabledIndication = "Server.AlarmNotificationsDisabledIndication"
	This message is sent when alarm notifications for an event has been manually disabled in the Smart Client. The Message.Data field contains the guid of the event.
const string	AlarmNotificationsEnabledIndication = "Server.AlarmNotificationsEnabledIndication"
	This message is sent when alarm notifications for an event has been re-enabled. The Message.Data field contains the guid of the event.
const string	ArchiveDiskAvailableMessage = "Archive Disk Available"
	Can appear in the NewEventIndication message.
const string	ArchiveFailureDiskUnavailableMessage = "Archive Failure: Disk Unavailable"
	Can appear in the NewEventIndication message.
const string	ArchiveFailureMessage = "Archive Failure"
	Can appear in the NewEventIndication message.
const string	ArchiveMoveFailureMessage = "Archive Move Failure"
	Can appear in the NewEventIndication message.
const String	ChangedAlarmHistoryIndication = "Server.ChangedAlarmHistoryIndication"
	This message is send within the Event Server environment, when one or more alarm histories has been updated. The Message.Data field contains a ChangedAlarmHistoriesData class.
const String	ChangedAlarmIndication = "Server.ChangedAlarmIndication"
	This message is send within the Event Server environment, when one or many alarms has been changed. The Message.Data field contains a ChangedAlarmData class.
const String	ConfigurationChangedIndication = "Server.ConfigurationChangedIndication"
	This message is being sent by the Environment to indicate that some part of a plug-in configuration has changed. The Message.RelatedFQID defines the top most Item that has changed. If the specific Item is not known only the Kind is filled with relevant content. You may use this information to reload from this Item and all it's children. The EventServer will use this information to reload a plug-ins Items and refresh relevant Maps. Please note that video management server configuration changes are being notified by the similar message under the System namespace (System.SystemConfigurationChangedIndication). This feature requires the EnvironmentManager.Instance.EnableConfigurationChangedService = true;.
const string	DatabaseBeingRepairedMessage = "Database being repaired"
	Can appear in the NewEventIndication message.
const string	DisabledMessage = "Disabled"
	Can appear in the NewEventIndication message.
const string	EnabledMessage = "Enabled"
	Can appear in the NewEventIndication message.
const String	EventCommand = "Server.EventCommand"
	Deprecated - see Server.NewEventCommand.
const string	ExternalEventMessage = "External Event"
	Can appear in the NewEventIndication message.
const string	GetAnalyticsMessagesRequest = "Analytics.GetAnalyticsMessagesRequest"
	Is used to get a list of all configured Analytics messages.
const string	GetAnalyticsMessagesResponse = "Analytics.GetAnalyticsMessagesResponse"
	Contains a response to the GetAnalyticsMessagesRequest message.
const String	GetIPAddressRequest = "Server.GetIPAddresRequest"
	To request IP address for a given camera. The Related FQID is the camera you need information about. The returned object is a string with the IP address.
const String	GetIPAddressResponse = "Server.GetIPAddresResponse"
	The response to the GetIPAddressRequest, when transmitted on the MessageCommunication to the event server.
const string	GetMapRequest = "Server.GetMapRequest"
	This request can be used in the Smart Client to get a list of child maps.
const string	GetMapResponse = "Server.GetMapResponse"
	Is sent as a result of a GetMapRequest. The message.Data field contains a MapResponseData class.
const string	MipItemPositionChangedIndication = "Server.MipItemPositionChangedIndication"
	This message ID is used when the PositioningInformation property of a MIP plugin item has changed.
const string	MotionDetectedMessage = "Motion Detected"
	Can appear in the NewEventIndication message.
const string	MotionEndMessage = "Motion End"
	Can appear in the NewEventIndication message.
const string	NewAlarmAsEventCommand = "Server.NewAlarmAsEventCommand"
	Deprecated - see Server.NewEventCommand.
const string	NewAlarmCommand = "Server.NewAlarmCommand"
	Plug-ins can send this message with an Alarm class in the Data field, to have the EventServer store the Alarm into the database. The Alarm will be stored unaltered except for these fields:
const String	NewAlarmIndication = "Server.NewAlarmIndication"
	This message Id is SEND by the Event server, to inform others that a new alarm has occurred.
const String	NewAlarmUpdatedIndication = "Server.NewAlarmUpdatedIndication"
	Obsolete. Do not use.
const String	NewAlertAsAlarmHandlerCommand = "Server.NewAlertAsAlarmHandlerCommand"
	Deprecated - see Server.NewEventCommand.
const String	NewEventAsAlarmHandlerCommand = "Server.NewEventAsAlarmHandlerCommand"
	Deprecated - see Server.NewAlarmCommand.
const String	NewEventCommand = "Server.NewEventCommand"
	Plug-ins sends a Message with this message id to inform the Event Server of a new event. If this is sent in the Smart Client or when running with the .Net Library, it will be transfered to the event server over a SOAP protocol. The EventServer will process the message for possible storage in the alarm database if it finds a match in one of the alarm definition. The Data field of the message can contain either an EventData or an AnalyticsEvent class.
const String	NewEventIndication = "Server.NewEventIndication"
	This message Id is SEND by the Event server, to inform others that a new event has occurred. Plug-in's running in the event server will be able to retrieve this message using the RegisterReceiver method. For receiving this message in other Environments than the event server, use the MessageCommunication classes.
const String	NewEventsCommand = "Server.NewEventsCommand"
	Should only be used in Event Server. Plug-ins sends a Message with this message id to inform the Event Server of multiple new events. The EventServer will process the events contained in the message for possible storage in the alarm database if it finds a match in one of the alarm definition. The Data field of the message should contain an IEnumerable containing object of either the EventData or the AnalyticsEvent class.
const String	NewEventsIndication = "Server.NewEventsIndication"
	This message Id is SEND by the Event server, to inform others that one or more new events has occurred. Plug-in's running in the event server will be able to retrieve this message using the RegisterReceiver method. For receiving this message in other Environments than the event server, use the MessageCommunication classes.
const string	NotRespondingMessage = "Not Responding"
	Can appear in the NewEventIndication message.
const string	OutputActivatedMessage = "Output Activated"
	Can appear in the NewEventIndication message.
const string	OutputDeactivatedMessage = "Output Deactivated"
	Can appear in the NewEventIndication message.
const String	RecorderFQIDChangedIndication = "Server.RecorderFQIDChangedIndication"
	This message ID is used when a failover has occurred in a Corporate system. The Message.RelatedFQID defines the recorder that has an updated address (WebServerUri). Please note, to listen to this message, use the EnvironmentManager RegisterReceiver method. Requires EnvironmentProperties.EnableConfigurationRefresh to be true.
const string	RespondingMessage = "Responding"
	Can appear in the NewEventIndication message.
const string	RunningOutOfDiskSpaceMessage = "Running Out of Disk Space"
	Can appear in the NewEventIndication message.
const string	ServerNotRespondingMessage = "Server Not Responding"
	Can appear in the NewEventIndication message.
const string	ServerRespondingMessage = "Server Responding"
	Can appear in the NewEventIndication message.
const string	SettingsChangedErrorMessage = "Settings Changed Error"
	Can appear in the NewEventIndication message.
const string	SettingsChangedMessage = "Settings Changed"
	Can appear in the NewEventIndication message.

Detailed Description

This class is a collection of static strings for server communications. The event and alarm messages will be sent to the EventServer and others represent communication to the logon server.

Member Data Documentation

AlarmNotificationsDisabledIndication

const string VideoOS.Platform.Messaging.MessageId.Server.AlarmNotificationsDisabledIndication = "Server.AlarmNotificationsDisabledIndication"

static

This message is sent when alarm notifications for an event has been manually disabled in the Smart Client. The Message.Data field contains the guid of the event.

AlarmNotificationsEnabledIndication

const string VideoOS.Platform.Messaging.MessageId.Server.AlarmNotificationsEnabledIndication = "Server.AlarmNotificationsEnabledIndication"

static

This message is sent when alarm notifications for an event has been re-enabled. The Message.Data field contains the guid of the event.

ArchiveDiskAvailableMessage

const string VideoOS.Platform.Messaging.MessageId.Server.ArchiveDiskAvailableMessage = "Archive Disk Available"

static

Can appear in the NewEventIndication message.

ArchiveFailureDiskUnavailableMessage

const string VideoOS.Platform.Messaging.MessageId.Server.ArchiveFailureDiskUnavailableMessage = "Archive Failure: Disk Unavailable"

static

Can appear in the NewEventIndication message.

ArchiveFailureMessage

const string VideoOS.Platform.Messaging.MessageId.Server.ArchiveFailureMessage = "Archive Failure"

static

Can appear in the NewEventIndication message.

ArchiveMoveFailureMessage

const string VideoOS.Platform.Messaging.MessageId.Server.ArchiveMoveFailureMessage = "Archive Move Failure"

static

Can appear in the NewEventIndication message.

ChangedAlarmHistoryIndication

const String VideoOS.Platform.Messaging.MessageId.Server.ChangedAlarmHistoryIndication = "Server.ChangedAlarmHistoryIndication"

static

This message is send within the Event Server environment, when one or more alarm histories has been updated. The Message.Data field contains a ChangedAlarmHistoriesData class.

ChangedAlarmIndication

const String VideoOS.Platform.Messaging.MessageId.Server.ChangedAlarmIndication = "Server.ChangedAlarmIndication"

static

This message is send within the Event Server environment, when one or many alarms has been changed. The Message.Data field contains a ChangedAlarmData class.

ConfigurationChangedIndication

const String VideoOS.Platform.Messaging.MessageId.Server.ConfigurationChangedIndication = "Server.ConfigurationChangedIndication"

static

This message is being sent by the Environment to indicate that some part of a plug-in configuration has changed.
The Message.RelatedFQID defines the top most Item that has changed. If the specific Item is not known only the Kind is filled with relevant content.
You may use this information to reload from this Item and all it's children.
The EventServer will use this information to reload a plug-ins Items and refresh relevant Maps.

Please note that video management server configuration changes are being notified by the similar message under the System namespace (System.SystemConfigurationChangedIndication).
This feature requires the EnvironmentManager.Instance.EnableConfigurationChangedService = true;.

DatabaseBeingRepairedMessage

const string VideoOS.Platform.Messaging.MessageId.Server.DatabaseBeingRepairedMessage = "Database being repaired"

static

Can appear in the NewEventIndication message.

DisabledMessage

const string VideoOS.Platform.Messaging.MessageId.Server.DisabledMessage = "Disabled"

static

Can appear in the NewEventIndication message.

EnabledMessage

const string VideoOS.Platform.Messaging.MessageId.Server.EnabledMessage = "Enabled"

static

Can appear in the NewEventIndication message.

EventCommand

const String VideoOS.Platform.Messaging.MessageId.Server.EventCommand = "Server.EventCommand"

static

Deprecated - see Server.NewEventCommand.

ExternalEventMessage

const string VideoOS.Platform.Messaging.MessageId.Server.ExternalEventMessage = "External Event"

static

Can appear in the NewEventIndication message.

GetAnalyticsMessagesRequest

const string VideoOS.Platform.Messaging.MessageId.Server.GetAnalyticsMessagesRequest = "Analytics.GetAnalyticsMessagesRequest"

static

Is used to get a list of all configured Analytics messages.

The request is serviced by the Event Server, so event server plugin can use "SendMessage" while support from other environments will need to use MessageCommunication.

Please register the message: GetAnalyticsMessagesRequest for the returning response.

GetAnalyticsMessagesResponse

const string VideoOS.Platform.Messaging.MessageId.Server.GetAnalyticsMessagesResponse = "Analytics.GetAnalyticsMessagesResponse"

static

Contains a response to the GetAnalyticsMessagesRequest message.

The message.Data field contains an array of AnalyticsMessageData

GetIPAddressRequest

const String VideoOS.Platform.Messaging.MessageId.Server.GetIPAddressRequest = "Server.GetIPAddresRequest"

static

To request IP address for a given camera. The Related FQID is the camera you need information about. The returned object is a string with the IP address.

Note: This only works in the EventServer from MIP v4 (EventServer 3.1a)
Note: From 2016 can be used everywhere. When transmitted on the MessageCommunication the Event Server will respond with a GetIPAddressResponse message where the Data contains the cameras IP address.

GetIPAddressResponse

const String VideoOS.Platform.Messaging.MessageId.Server.GetIPAddressResponse = "Server.GetIPAddresResponse"

static

The response to the GetIPAddressRequest, when transmitted on the MessageCommunication to the event server.

The Data field of the response contains result as a string like "http://1.2.3.4" or "http://1.2.3.4:5555".

Note: Can only identify address of cameras, all other items will respond with null or blank.

(Supported from 2016)

GetMapRequest

const string VideoOS.Platform.Messaging.MessageId.Server.GetMapRequest = "Server.GetMapRequest"

static

This request can be used in the Smart Client to get a list of child maps.

The Message.Data is filled with a MapRequestData containing a serverId and the id of the current map to get child maps for. Use ID = "" for the top map.

The result will be send in a new message with id GetMapResponse.

GetMapResponse

const string VideoOS.Platform.Messaging.MessageId.Server.GetMapResponse = "Server.GetMapResponse"

static

Is sent as a result of a GetMapRequest. The message.Data field contains a MapResponseData class.

MipItemPositionChangedIndication

const string VideoOS.Platform.Messaging.MessageId.Server.MipItemPositionChangedIndication = "Server.MipItemPositionChangedIndication"

static

This message ID is used when the PositioningInformation property of a MIP plugin item has changed.

The Message.RelatedFQID property of the message will contain the ID of the item that has moved and the Message.Data property will contain the new PositioningInformation value.

MotionDetectedMessage

const string VideoOS.Platform.Messaging.MessageId.Server.MotionDetectedMessage = "Motion Detected"

static

Can appear in the NewEventIndication message.

MotionEndMessage

const string VideoOS.Platform.Messaging.MessageId.Server.MotionEndMessage = "Motion End"

static

Can appear in the NewEventIndication message.

NewAlarmAsEventCommand

const string VideoOS.Platform.Messaging.MessageId.Server.NewAlarmAsEventCommand = "Server.NewAlarmAsEventCommand"

static

Deprecated - see Server.NewEventCommand.

NewAlarmCommand

const string VideoOS.Platform.Messaging.MessageId.Server.NewAlarmCommand = "Server.NewAlarmCommand"

static

Plug-ins can send this message with an Alarm class in the Data field, to have the EventServer store the Alarm into the database.
The Alarm will be stored unaltered except for these fields:

• State will be set to "New"
  
  Be aware that the Message property of the EventHeader of the alarm is used to categorize the alarms, and thus should not be unique for each alarm, but rather like a type for the alarm.

NewAlarmIndication

const String VideoOS.Platform.Messaging.MessageId.Server.NewAlarmIndication = "Server.NewAlarmIndication"

static

This message Id is SEND by the Event server, to inform others that a new alarm has occurred.

When running in other Environments, the MessageCommunication classes can be used to retrieve the NewAlarmIndication from the Event Server.

Note: In the Smart Client, changes to an Alarm will also use the NewAlarmIndication to send out the changes in an AlarmLine class. You will need to try to cast the Message.Data to both the Alarm and the AlarmLine to identify which one it is.

NewAlarmUpdatedIndication

const String VideoOS.Platform.Messaging.MessageId.Server.NewAlarmUpdatedIndication = "Server.NewAlarmUpdatedIndication"

static

Obsolete. Do not use.

NewAlertAsAlarmHandlerCommand

const String VideoOS.Platform.Messaging.MessageId.Server.NewAlertAsAlarmHandlerCommand = "Server.NewAlertAsAlarmHandlerCommand"

static

Deprecated - see Server.NewEventCommand.

NewEventAsAlarmHandlerCommand

const String VideoOS.Platform.Messaging.MessageId.Server.NewEventAsAlarmHandlerCommand = "Server.NewEventAsAlarmHandlerCommand"

static

Deprecated - see Server.NewAlarmCommand.

NewEventCommand

const String VideoOS.Platform.Messaging.MessageId.Server.NewEventCommand = "Server.NewEventCommand"

static

Plug-ins sends a Message with this message id to inform the Event Server of a new event. If this is sent in the Smart Client or when running with the .Net Library, it will be transfered to the event server over a SOAP protocol. The EventServer will process the message for possible storage in the alarm database if it finds a match in one of the alarm definition.
The Data field of the message can contain either an EventData or an AnalyticsEvent class.

NewEventIndication

const String VideoOS.Platform.Messaging.MessageId.Server.NewEventIndication = "Server.NewEventIndication"

static

This message Id is SEND by the Event server, to inform others that a new event has occurred.
Plug-in's running in the event server will be able to retrieve this message using the RegisterReceiver method. For receiving this message in other Environments than the event server, use the MessageCommunication classes.

Only register to listen for either: NewEventIndication or NewEventsIndication
If a receiver listen for the NewEventIndication, the MIP Environment will split the NewEventsIndication into separate messages - in order to be backwards compatible.

NewEventsCommand

const String VideoOS.Platform.Messaging.MessageId.Server.NewEventsCommand = "Server.NewEventsCommand"

static

Should only be used in Event Server. Plug-ins sends a Message with this message id to inform the Event Server of multiple new events. The EventServer will process the events contained in the message for possible storage in the alarm database if it finds a match in one of the alarm definition.
The Data field of the message should contain an IEnumerable containing object of either the EventData or the AnalyticsEvent class.

NewEventsIndication

const String VideoOS.Platform.Messaging.MessageId.Server.NewEventsIndication = "Server.NewEventsIndication"

static

This message Id is SEND by the Event server, to inform others that one or more new events has occurred.
Plug-in's running in the event server will be able to retrieve this message using the RegisterReceiver method. For receiving this message in other Environments than the event server, use the MessageCommunication classes.

Only register to listen for either: NewEventIndication or NewEventsIndication
If a receiver listen for the NewEventIndication, the MIP Environment will split the NewEventsIndication into separate messages - in order to be backwards compatible.

NotRespondingMessage

const string VideoOS.Platform.Messaging.MessageId.Server.NotRespondingMessage = "Not Responding"

static

Can appear in the NewEventIndication message.

OutputActivatedMessage

const string VideoOS.Platform.Messaging.MessageId.Server.OutputActivatedMessage = "Output Activated"

static

Can appear in the NewEventIndication message.

OutputDeactivatedMessage

const string VideoOS.Platform.Messaging.MessageId.Server.OutputDeactivatedMessage = "Output Deactivated"

static

Can appear in the NewEventIndication message.

RecorderFQIDChangedIndication

const String VideoOS.Platform.Messaging.MessageId.Server.RecorderFQIDChangedIndication = "Server.RecorderFQIDChangedIndication"

static

This message ID is used when a failover has occurred in a Corporate system. The Message.RelatedFQID defines the recorder that has an updated address (WebServerUri). Please note, to listen to this message, use the EnvironmentManager RegisterReceiver method. Requires EnvironmentProperties.EnableConfigurationRefresh to be true.

RespondingMessage

const string VideoOS.Platform.Messaging.MessageId.Server.RespondingMessage = "Responding"

static

Can appear in the NewEventIndication message.

RunningOutOfDiskSpaceMessage

const string VideoOS.Platform.Messaging.MessageId.Server.RunningOutOfDiskSpaceMessage = "Running Out of Disk Space"

static

Can appear in the NewEventIndication message.

ServerNotRespondingMessage

const string VideoOS.Platform.Messaging.MessageId.Server.ServerNotRespondingMessage = "Server Not Responding"

static

Can appear in the NewEventIndication message.

ServerRespondingMessage

const string VideoOS.Platform.Messaging.MessageId.Server.ServerRespondingMessage = "Server Responding"

static

Can appear in the NewEventIndication message.

SettingsChangedErrorMessage

const string VideoOS.Platform.Messaging.MessageId.Server.SettingsChangedErrorMessage = "Settings Changed Error"

static

Can appear in the NewEventIndication message.

SettingsChangedMessage

const string VideoOS.Platform.Messaging.MessageId.Server.SettingsChangedMessage = "Settings Changed"

static

Can appear in the NewEventIndication message.