VideoOS.Platform.Messaging.MessageId.System Class Reference

This class is a collection of static strings used for messages relevant on a system level. More...

Static Public Attributes
static String	ApplicationExitIndication = "System.ApplicationExitIndication"
	This message has been deprecated. Use the ClientControl.ApplicationCloseEvent event instead.
static String	ApplicationLoggedOffIndication = "System.ApplicationLoggedOffIndication"
	This message is sent when the user has just logged off a server. Try avoiding to use this message, and instead use the Close() method on the different plug-in classes.
static String	ApplicationLoggedOnIndication = "System.ApplicationLoggedOnIndication"
	This message is sent when the user has just logged on to a server. Try avoiding to use this message, and instead use the Init() method on the different plug-in classes.
static String	ApplicationRefreshTreeViewCommand = "System.ApplicationRefreshTreeViewCommand"
	This message can be send by a plug-in in the administrators when the plug-in has an updated list of items to show in the TreeView. This message should not be used during normal Add/Delete/Rename operations. The message will only work for the currently shown plug-in tree, and either the Data or the RelatedFQID.Kind of the message should match the Kind of the items that should be refreshed.
static String	LicenseAutomaticUpdateRequest = "System.LicenseAutomaticUpdateRequest"
	Can be sent by a MIP plug-in running in the Management Client, to indicate that its license information has changed. The environment will then call the PluginLicenseRequest methods to get a new set of license requests. The information will be stored on the server and used during next automatic license activation - usually scheduled to be performed within a few minutes.
static String	LicenseChangedIndication = "System.LicenseChangedIndication"
	When licenses has been activated, this event is sent. You can afterwards call the GetLicense(pluginId) method to retrieve your licenses.
static String	LocalConfigurationChangedIndication = "System.LocalConfigurationChangedIndication"
	When running with the .Net library, this message is sent when the memory copy of the configuration has been updated. This can happen as a result of a late connection to a sub-site, or an update to one recorder.
static String	LoginTokenChangedIndication = "System.LoginTokenChangedIndication"
	When the login token has changed (LoginSettings.IdentityTokenCache, if LoginSettings.IsOAuthConnection is true, and otherwise LoginSettings.Token) a message with this Id is posted. The LoginSettings event can also be used to know when a token has changed.
static String	ModeChangeCommand = "System.ModeChangeCommand"
	Can be sent to the individual PlaybackController in the .Net Library MIP and Smart Client Environment when the application want to change mode for one PlaybackController and all related ImageViewerControl's. The destination parameter must contain the FQID of the PlaybackController that should handle the command. The Message.Data property should be one of the values in Mode.
static String	ModeChangedIndication = "System.ModeChangedIndication"
	Is sent when the Smart Client or the .Net Library MIP Environment has changed mode. The Data field contains the new Mode, so does EnvironmentManager.Mode. Note: Do not use this message in Smart Client plugins. Instead use ShownWorkSpace, WorkSpaceState and associated messages.
static String	RemovableMasksLiftedChangedIndication = "System.RemovableMasksLiftedChangedIndication"
	This message is deprecated and should no longer be used. Instead use the UserContext.PrivacyMaskLiftChanged event.
static String	SystemConfigurationChangedDetailsIndication = "System.SystemConfigurationChangedDetailsIndication"
	This message is sent when part of the VMS configuration has changed in general. Please note that many of these messages can be sent, and a plug-in should not reload or re-check the entire configuration at every event.
static String	SystemConfigurationChangedIndication = "System.SystemConfigurationChangedIndication"
	This message is sent when part of the VMS configuration has changed in general. Please note that many of these messages can be sent, and a plug-in should not reload or re-check the entire VMS configuration at every event.

Detailed Description

This class is a collection of static strings used for messages relevant on a system level.

Member Data Documentation

ApplicationExitIndication

String VideoOS.Platform.Messaging.MessageId.System.ApplicationExitIndication = "System.ApplicationExitIndication"

static

This message has been deprecated.
Use the ClientControl.ApplicationCloseEvent event instead.

ApplicationLoggedOffIndication

String VideoOS.Platform.Messaging.MessageId.System.ApplicationLoggedOffIndication = "System.ApplicationLoggedOffIndication"

static

This message is sent when the user has just logged off a server.
Try avoiding to use this message, and instead use the Close() method on the different plug-in classes.

ApplicationLoggedOnIndication

String VideoOS.Platform.Messaging.MessageId.System.ApplicationLoggedOnIndication = "System.ApplicationLoggedOnIndication"

static

This message is sent when the user has just logged on to a server.
Try avoiding to use this message, and instead use the Init() method on the different plug-in classes.

ApplicationRefreshTreeViewCommand

String VideoOS.Platform.Messaging.MessageId.System.ApplicationRefreshTreeViewCommand = "System.ApplicationRefreshTreeViewCommand"

static

This message can be send by a plug-in in the administrators when the plug-in has an updated list of items to show in the TreeView.
This message should not be used during normal Add/Delete/Rename operations. The message will only work for the currently shown plug-in tree, and either the Data or the RelatedFQID.Kind of the message should match the Kind of the items that should be refreshed.

LicenseAutomaticUpdateRequest

String VideoOS.Platform.Messaging.MessageId.System.LicenseAutomaticUpdateRequest = "System.LicenseAutomaticUpdateRequest"

static

Can be sent by a MIP plug-in running in the Management Client, to indicate that its license information has changed.
The environment will then call the PluginLicenseRequest methods to get a new set of license requests.
The information will be stored on the server and used during next automatic license activation - usually scheduled to be performed within a few minutes.

Note: Supported from 2016.

LicenseChangedIndication

String VideoOS.Platform.Messaging.MessageId.System.LicenseChangedIndication = "System.LicenseChangedIndication"

static

When licenses has been activated, this event is sent. You can afterwards call the GetLicense(pluginId) method to retrieve your licenses.

LocalConfigurationChangedIndication

String VideoOS.Platform.Messaging.MessageId.System.LocalConfigurationChangedIndication = "System.LocalConfigurationChangedIndication"

static

When running with the .Net library, this message is sent when the memory copy of the configuration has been updated. This can happen as a result of a late connection to a sub-site, or an update to one recorder.

When MIP .Net Library has loaded configuration from a server, this message is fired with the RelatedFQID being the Management Server FQID.

When MIP .Net Library has updated configuration after hardware has been moved, or hardware being renamed, this message is being fired with the Data field containing a "List<FQID>" to identify each of the items that has changes (e.g. cameras or metadata items)

LoginTokenChangedIndication

String VideoOS.Platform.Messaging.MessageId.System.LoginTokenChangedIndication = "System.LoginTokenChangedIndication"

static

When the login token has changed (LoginSettings.IdentityTokenCache, if LoginSettings.IsOAuthConnection is true, and otherwise LoginSettings.Token) a message with this Id is posted. The LoginSettings event can also be used to know when a token has changed.

For LoginSettings.IdentityTokenCache this will only be issued in the Smart Client environment and only if the token cache itself has been replaced. The token cache will in all other cases internally ensure that its token is always up-to-date.
It should be noted, that each Management Server added to a system will have its own token, and will be re-newed at interval specified for each system. Be very careful when receiving this message to ensure that you use the one that is relevant for your current item.
This can be done by checking that the LoginSettings.Id is the same as for the Management Server that owns the Item you are currently working with, e.g. the event handler for this message contains:

LoginSettings ls = message.Data as LoginSettings;
FQID recorderServerFQID = _cameraFQID.GetParent();    <br>
if (ls.Guid != recorderServerFQID.ParentId) // Parent to recorder is the Management Server
   return null;

A related method for getting the token is using the TokenChangedEvent on the LoginSettings class.

ModeChangeCommand

String VideoOS.Platform.Messaging.MessageId.System.ModeChangeCommand = "System.ModeChangeCommand"

static

Can be sent to the individual PlaybackController in the .Net Library MIP and Smart Client Environment when the application want to change mode for one PlaybackController and all related ImageViewerControl's.
The destination parameter must contain the FQID of the PlaybackController that should handle the command. The Message.Data property should be one of the values in Mode.

ModeChangedIndication

String VideoOS.Platform.Messaging.MessageId.System.ModeChangedIndication = "System.ModeChangedIndication"

static

Is sent when the Smart Client or the .Net Library MIP Environment has changed mode.
The Data field contains the new Mode, so does EnvironmentManager.Mode. Note: Do not use this message in Smart Client plugins. Instead use ShownWorkSpace, WorkSpaceState and associated messages.

RemovableMasksLiftedChangedIndication

String VideoOS.Platform.Messaging.MessageId.System.RemovableMasksLiftedChangedIndication = "System.RemovableMasksLiftedChangedIndication"

static

This message is deprecated and should no longer be used. Instead use the UserContext.PrivacyMaskLiftChanged event.

SystemConfigurationChangedDetailsIndication

String VideoOS.Platform.Messaging.MessageId.System.SystemConfigurationChangedDetailsIndication = "System.SystemConfigurationChangedDetailsIndication"

static

This message is sent when part of the VMS configuration has changed in general. Please note that many of these messages can be sent, and a plug-in should not reload or re-check the entire configuration at every event.

The Data field is filled with a SystemConfigurationChangedDetailsIndicationData class that contains which objects has been changed, and what type of change was done.

SystemConfigurationChangedIndication

String VideoOS.Platform.Messaging.MessageId.System.SystemConfigurationChangedIndication = "System.SystemConfigurationChangedIndication"

static

This message is sent when part of the VMS configuration has changed in general. Please note that many of these messages can be sent, and a plug-in should not reload or re-check the entire VMS configuration at every event.