EasyUA Reference
UaClient Class Members
See Also  Fields  Properties  Methods  Events Send Feedback
EasyUA Assembly > Advosol.EasyUA Namespace : UaClient Class

Glossary Item Box

The following tables list the members exposed by UaClient.

Public Constructors

 NameDescription
Public ConstructorUaClient Constructor Constructor.  
Top

Public Fields

 NameDescription
Public Fieldstatic (Shared in Visual Basic)LicensedFunctionality Functionality for which a license was found. The indication is e.g. "DA" or DA, HD, AC"  
Top

Public Properties

 NameDescription
Public PropertyappConfig The UA application configuration. The method LoadConfiguration() can be used to load the onfiguration file into the proiperty.  
Public PropertyapplicationTypeThe type of UA application. The default is ApplicationType.Client.
If an application also include a UA server the the type needs to be set to ApplicationType.ClientAndServer.
The defined type must atch the type defined in the configuration file.  
Public PropertyapplyTraceSettings If TRUE then the trace settings from the configuration file are applied. The default is TRUE.  
Public PropertybindingFactory The BindingFactorey to be used. The default is BindingFactory.Default  
Public PropertyCertificateDomainMustMatch If true (default) then the certificate domain must match the domain of the accessed server. This property is used when the session is created.  
Public PropertyconfigFilenameThe path name of the file with the UA configuration settings.
The default name is the executable name with ".Ua.Config.Xml" appended. E.g. myclient.Ua.Config.xml  
Public PropertyfindServerEndpointUris List of servers to return by the FindServers() method. All known servers are returned if the list is empty.  
Public Propertystatic (Shared in Visual Basic)License License string if it's preferred to have it within the application instead of a license file.  
Public PropertypreferredLocales List of preferred Locales. The default is an empty list.  
Public PropertyRequestHeaderFind The RequestSettings used for FindServerOnNetwork  
Public Propertystatic (Shared in Visual Basic)UaAppConfigFileAutoCreate If not null then an application configuration file is created unless it already exists. The defined name is used as the appliction name.  
Public PropertyUaTraceMask  
Top

Public Methods

 NameDescription
Public MethodBeginFindServersFind the local UA server thru a Local Discovery Server (LDS). The LDS URLs are defined in the UA configuration as WellKnownDiscoveryUrls. The ApplicationDesciption is returned for each found server.  
Public MethodBeginFindServerUrlsFind the local UA server thru a Local Discovery Server (LDS). The LDS URLs are defined in the UA configuration as WellKnownDiscoveryUrls. The ApplicationDesciption is returned for each found server.  
Public MethodCreateSessionOverloaded. Creates a new communication session with a server by invoking the CreateSession service.  
Public MethodEndCreateSession Completes an asynchronous CreateSession operation.  
Public MethodEndFindServers Completes an asynchronous FindServers operation.  
Public MethodEndFindServerUrls Completes an asynchronous FindServerUrls operation.  
Public MethodFindServersOverloaded. Find the local UA server thru a Local Discovery Server (LDS). The LDS URLs are defined in the UA configuration as WellKnownDiscoveryUrls. The ApplicationDesciption is returned for each found server.  
Public MethodFindServersOnNetwork Find the UA servers from a Local Discovery Server (LDS). The LDS URLs are defined in the UA configuration as WellKnownDiscoveryUrls. The ApplicationDesciption is returned for each found server.  
Public MethodFindServerUrls Find the local UA server thru a Local Discovery Server (LDS). The LDS URLs are defined in the UA configuration as WellKnownDiscoveryUrls. The URL is returned for each found server.  
Public MethodGetAsyncError Retrieve the async handler exception indicator.  
Public Methodstatic (Shared in Visual Basic)GetEndpointID Get a descriptive endpoint ID for display in endpoint selections.  
Public Methodstatic (Shared in Visual Basic)GetEndpoints Retrieve the endpoints of the defiend UA server.  
Public MethodLoadConfiguration Load the UA configuration from the configuration file specified in the configFilename property and store it in the appConfig property.  
Public MethodRecreate Recreates a session based on a specified template.  
Public MethodTerminateSession The session is disconnected from the server and the network resources are freed. The session object is disposed. The timeout period is the session keepAliveInterval  
Top

Public Events

 NameDescription
Public EventUaTraceNotification Event to hook into the trace logging  
Top

See Also

Copyright © 2018 Advosol Inc. All Rights Reserved.