Skip to main content
View as Markdown

INotification interface

The INotification interface is used by the IClient, IServerView, IServerDocument, IServerModule, INotificationHandler interfaces.

public interface INotification

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Derived: IGUIManagerNotification, IValidateStateTransitionNotification, IValidateStateTransitionNotificationEx, IVaultFileLessDocumentNotification, IVaultFileLessReleaseNotification, IWebBrowserNotification

Remarks​

The notifications could be a document loading notification, workspace being loaded, an object being navigated, and a server module being loaded.

Notifications as event messages can be broadcasted by the Client system, and any open server documents can receive them and act on them accordingly.

The Broadcast Notification is a system wide notification, and the Dispatch Notification is a server specific notification.

Methods​

MethodReturnsDescription
GetNotificationCodeint
GetNotificationDataobject
GetNotificationTypestring

GetNotificationCode​

No description yet.

int GetNotificationCode();

Returns: int

Examples: Ciiva, Extension_Preference

GetNotificationData​

No description yet.

object GetNotificationData();

Returns: object

GetNotificationType​

No description yet.

string GetNotificationType();

Returns: string

Examples: Ciiva, Extension_Preference

Accepted by​

IClient.BroadcastNotification, IClient.BroadcastNotificationAsynchronously, IClient.DispatchNotification, INotificationHandler.HandleNotification, IReleasedItemDocument.Notify, IServerDocument.NotifyViews, IServerModule.ReceiveNotification, IServerView.ReceiveNotification, IVaultExplorerForm.ReceiveNotification, IVaultExplorerServer.NotifyModalVaultExplorer, IVaultExplorerServer.NotifySimpleVaultExplorer, IInstrumentView.ReceiveNotification

Examples​

Used in the SDK examples: Ciiva, Extension_Preference.