Click or drag to resize

ClientOperations Class

Provides a simple interface for updating the MFAdmin configuration interface. Instances of this class are created by AdminConfigurationManagerBase for node requests that can return proper responses. The appropriate node methods or custom command methods are then passed the instance so the MFAdmin interface can be informed of any changes made on the server. Each client operation method generates one or more directives that are then passed back to MFAdmin at the end of the request.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.Configuration.AdminConfigurationsClientOperations

Namespace:  MFiles.VAF.Configuration.AdminConfigurations
Assembly:  MFiles.VAF.Configuration (in MFiles.VAF.Configuration.dll) Version: 2.2.0.9
Syntax
C#
public class ClientOperations

The ClientOperations type exposes the following members.

Constructors
  NameDescription
Public methodClientOperations
Constructor.
Top
Properties
  NameDescription
Public propertyContext
The context of the request that this interface will provide a response to.
Public propertyDefaultNodeLocation
The configuration domain node this response is for.
Public propertyDirectives
The list of directives to be sent to the client as the response.
Public propertyManager
The manager responsible for the nodes that can be modified through this interface.
Top
Methods
  NameDescription
Public methodAddSubNode
Inserts a node into the client underneath the parent node. This will have no effect if the paren't nodes have not yet loaded.
Public methodAuthenticateUser
Instructs MFAdmin to authenticate a user.
Public methodGetResponse
Provides a command response with the applicable client operations that have been called.
Public methodLoadConfiguration
Sets the configuration text for a domain in the client. Be wary! This can overwrite unsaved changes the user has made.
Public methodRefreshDashboard
Invalidates a node's dashboard, forcing it to refresh if it is currently viewed, or the next time a user tries to view it.
Public methodRefreshMetadataCache
Forces the MFAdmin configurator to refresh it's metadata structure cache. It is wise to call this if a command has changes the metaddata structure of the vault. (e.g. Add, remove, update object types, classes, property defs, workflows, etc...). This can take significant time on the client, so use this sparingly!
Public methodReloadDomain
Completely reloads a domain in the MFAdmin configurator, but only if the parent domain has been loaded. Use this carefully, as it can be very destructive, and users can lose unsaved changes. Consider UpdateDomain instead, to try and make updates in place.
Public methodRemoveNode
Removes a node from the client.
Public methodRevalidateDomain
Forces a domain on the client to re-run server validation. If the configuration or vault structure has changed, this may be wise to call.
Public methodShowMessage
Shows an informational message to the user.
Public methodUpdateCommands
Udpates the list of avaliable commands. The updated list is retrieved from the corresponding node method.
Public methodUpdateDashboard(String, String, DashboardUpdateMode)
Updates the default node's dashboard. Either completely, or a targeted section.
Public methodUpdateDashboard(IDashboardContent, String, DashboardUpdateMode)
Updates the default node's dashboard. Either completely, or a targeted section.
Public methodUpdateDomain
Refreshes information about the node. This allows for basic node information like DisplayName, Description and Priority to be updated, and also updates the nodes status and commands if those are supported. The updated values are gathered from the node itself via applicable interface methods.
Public methodUpdateStatus
Updates the nodes status in MFAdmin. Consider using UpdateDomain(DomainNodeLocation) if other information and/or commands are being updated as well.
Top
See Also