OmniChannelControl Class

Specifies a dictionary of associated actions

Specifies a dictionary of associated actions.

Stores the current UII context values

A reference to the IDesktopUserActions interface that provides access to some basic session management functions.

Initialization string that contains information about the control.

Gets or sets the agent ID.

Gets or sets the application host work item.

Gets or sets the host application.

Gets the unique id for this hosted application.

Gets the name of the hosted application.

Gets a Boolean value that specifies whether the application can be hosted within the UII panels.

Gets or set the hosted controls configuration value reader object.

Gets or sets the session-wide context. Modifying this also notifies other applications of the context change.

Gets or sets the control header.

Gets the name of the UII panel this application is hosted within.

Gets or sets the name of the control.

Gets the Boolean value that specifies whether auto sign on is enabled.

Gets or sets the icone.

Gets or sets the image source.

Gets a Boolean value that specifies whether the system runs certain routines as CCF 2.0 or prior.

Gets a boolean value that specifies whether the adapter is a session controller.

Gets or sets a Boolean value that specifies whether this instance is dynamic.

Gets or sets a Boolean value that specifies whether the hosted application is global.

Gets a Boolean value that specifies whether the application is listed in SessionExplorer or CurrentSessionUI

Gets a Boolean value that specifies whether the application is changing its state.

Gets or sets a Boolean value that specifies whether the application is dependent on workflow.

Gets or sets a reference to the session where this control exists. The session reference is used as input to many Global Manager functions.

Gets or sets a reference to the session manager. localSession is one of the sessions contained in the session manager.

Gets or sets the minimum size up to which the control can be resized.

Gets the size the optimum size of the application’s window.

Gets or sets the text for the window or tab control containing this application.

Gets the top level window of this hosted app.

Gets the top level wpf window of the hosted application.

Gets or sets whether a user can close the control.

Adds an action for use from one application or the UII core to this application.

Adds an implicit action.

Blocks the pop up errors.

Checks whether it is an appropriate time to show the control header. Derived classes may call this to update the visibility based on actions taken in the derived class.

Occurs on startup when all the desktop initialization in Unified Service Desk has completed and the connections to Microsoft Dynamics 365 have been established.

Used by an obselete workaround for SetParent use in User Interface Integration (UII).

Allows a global hosted control to get notification about the desktop loading being completed.

Occurs on startup when all the desktop initialization in Unified Service Desk has completed and the connections to Microsoft Dynamics 365 have been established.

Method to override in the implemention to handle the action.

Called to perform the action configured in the database.

Action handler for the hosted control.

Called to perform the action configured in the database.

Performs this hosted application's default action, if there is one.

Displays the error message.

Informs all the other applications that the context has changed.

Fires and event to the event configuration for the control. It is executed on the same session that the control lives in.

Fires and event to the event configuration for the control. It is executed on the same session that the control lives in.

Sends a request to perform some action to another application.

Obtains a reference to the specified hosted control by name, on the same session as this hosted control.

Retrieves the DynamicsCustomerRecord which contains all the data about the current customer.

Gets the list of icons.

Gets the list of image source.

Gets the application state data.

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.

Initialize function called by UII when a hosted control is loaded

Logs an exception with information about the trace event type that caused the exception.

Logs an exception with user-provided error message and information about the trace event type that caused the exception.

UII function that provides notification whenever Replacement parameters or the context have changed. This function is called frequently so no long running code should be placed into this override. It is recommended that you avoid using this override except when it is absolutely necessary.

Notifies the application of a context change.

The control writer should call PopulateToolbars passing a reference to their ToolbarTray. This function will read the configuration and populate the buttons based on the toolbar configuration assigned to this hosted control on the server.

An overridable function that DynamicsBaseHostedControl calls after it has routed a window in response to it's action handlers (new, open, etc). The base class version of this fires an event called "PopupRouted" so it can be handled in configuration.

Represents the method that will handle the SafeDispatcherUnhandledException event.

Activates or deactivates the session. Not called for non-global applications.

Override that is called when a session is closing.

Called by the system to indicate a session was created

Called by the system to indicate that a session is being hidden

Called by the system to indicate that a session is being shown

This is used to set the context from applicationhost without causing further notifications.

This is used to set the context from applicationhost without causing further notifications.

System calls this function to set the IDesktopUserActions interface.

Sets the StateData ofthe controls

Set the visual properties such as height, width, and visibility of a hosted control.

Special initialization method that is invoked every time an instance of this control is created.

For internal use only

Event to notify the hosted application that an action has completed.

Notifies the hosted application that the context has changed.

For internal use only

Requests the action of another application to be invoked.

Notifies the hosted application of action status.

Sets the local session.