Interface Description
Check out this article and learn more details about the WEBfactory 2010 Client SDK through the interface description article.
Overview of Communication Classes
Each WEBfactory 2010 2006 Control has one WFConnector class that connects to a common WFDataProvider class:
SDK Class structure
Collecting Requests
WFDataProvider class connects internally to a specific WEBfactory 2010 Server and requests all needed information for the application at once. Even if there are hundreds of controls located on a page only one WFDataProvider collects those requests and there will be only one connection to WEBfactory 2010 .
Common Information
This WFDataProvider runs for the entire life cycle of the Silverlight application. Static information like translations and languages can be read once and cached for further requests. This also reduces network traffic and CPU usage of server and client.
With that bundling feature we make sure to have synchronized refresh of the graphical user interface.
WFConnector Class Overview
These methods and events are implemented by WFConnector class (click on the title to expand/click on "view more details" to go to the corresponding page):
void RegisterSignalChangedHandler(string serverName, string signalName,
OnSignalChangedDelegate onSignalChangedDelegate);
void UnregisterSignalChangedHandler(string serverName, string signalName,
OnSignalChangedDelegate onSignalChangedDelegate);
void RegisterSignal(string serverName, string signalName);
void UnregisterSignal(string serverName, string signalName);
object GetSignalValue(string serverName, string signalName);
void WriteSignal(string serverName, string signalName, object value);
void WriteSignal(string serverName, string signalName, object value,
OnResultDelegate resultDelegate);
void WriteSignal(string serverName, string signalName, object value, string user,
string password);
void WriteSignal(string serverName, string signalName, object value, string user,
string password, bool isDomainUser);
void WriteSignal(string serverName, string signalName, object value, string user,
string password, OnResultDelegate resultDelegate);
void WriteSignal(string serverName, string signalName, object value, string user,
string password, bool isDomainUser, OnResultDelegate resultDelegate);
void WriteSignal(string serverName, string signalName, object value, string password);
void WriteSignal(string serverName, string signalName, object value, string password,
OnResultDelegate resultDelegate);
void ToggleSignal(string serverName, string signalName, object onValue, object offValue);
void ToggleSignal(string serverName, string signalName, object onValue, object offValue,
OnResultDelegate resultDelegate);
void SetAlarmState(string serverName, string alarmId, WFAlarmStates state,
DateTime reactivation);
void SetAlarmState(string serverName, string alarmId, WFAlarmStates state,
DateTime reactivation, OnResultDelegate resultDelegate);
void SetAlarmState(string serverName, string alarmId, WFAlarmStates state,
DateTime reactivation, string user, string password);
void SetAlarmState(string serverName, string alarmId, WFAlarmStates state,
DateTime reactivation, string user, string password, bool isDomainUser);
void SetAlarmState(string serverName, string alarmId, WFAlarmStates state,
DateTime reactivation, string user, string password, OnResultDelegate resultDelegate);
void SetAlarmState(string serverName, string alarmId, WFAlarmStates state,
DateTime reactivation, string user, string password, bool isDomainUser,
OnResultDelegate resultDelegate);
void SetAlarmStates(string serverName, string[] alarmIds, WFAlarmStates[] states,
DateTime[] reactivations);
void SetAlarmStates(string serverName, string[] alarmIds, WFAlarmStates[] states,
DateTime[] reactivations, OnResultDelegate resultDelegate);
void SetAlarmStates(string serverName, string[] alarmIds, WFAlarmStates[] states,
DateTime[] reactivations, string user, string password);
void SetAlarmStates(string serverName, string[] alarmIds, WFAlarmStates[] states,
DateTime[] reactivations, string user, string password, bool isDomainUser);
void SetAlarmStates(string serverName, string[] alarmIds, WFAlarmStates[] states,
DateTime[] reactivations, string user, string password, OnResultDelegate resultDelegate);
void SetAlarmStates(string serverName, string[] alarmIds, WFAlarmStates[] states,
DateTime[] reactivations, string user, string password, bool isDomainUser,
OnResultDelegate resultDelegate);
void SetSignalState(string serverName, string signalName, WFSignalState state);
void SetSignalState(string serverName, string signalName, WFSignalState state,
OnResultDelegate resultDelegate);
void SeSignalState(string serverName, string signalName, WFSignalState state,
string user, string password);
void SetSignalState(string serverName, string signalName, WFSignalState state,
string user, string password, OnResultDelegate resultDelegate);
void SetSignalState(string serverName, string signalName, WFSignalState state,
object inactiveValue);
void SetSignalState(string serverName, string signalName, WFSignalState state,
object inactiveValue, OnResultDelegate resultDelegate);
void SeSignalState(string serverName, string signalName, WFSignalState state,
object inactiveValue, string user, string password);
void SeSignalState(string serverName, string signalName, WFSignalState state,
object inactiveValue, string user, string password, bool isDomainUser);
void SetSignalState(string serverName, string signalName, WFSignalState state,
object inactiveValue, string user, string password, OnResultDelegate resultDelegate);
void SetSignalState(string serverName, string signalName, WFSignalState state,
object inactiveValue, string user, string password, bool isDomainUser, OnResultDelegate resultDelegate);
void SetSignalStates(string serverName, string[] signalNames, WFSignalState[] states);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
OnResultDelegate resultDelegate);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
string user, string password);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
string user, string password, bool isDomainUser);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
string user, string password, OnResultDelegate resultDelegate);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
string user, string password, bool isDomainUser, OnResultDelegate resultDelegate);
void SetSignalStates(string serverName, string[] signalNames, WFSignalState[] states,
object[] inactiveValues);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
object[] inactiveValues, OnResultDelegate resultDelegate);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
object[] inactiveValues, string user, string password);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
object[] inactiveValues, string user, string password, bool isDomainUser);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
object[] inactiveValues, string user, string password, OnResultDelegate resultDelegate);
void SetSignalStates (string serverName, string[] signalNames, WFSignalState[] states,
object[] inactiveValues, string user, string password, bool isDomainUser,
OnResultDelegate resultDelegate);
void LoginUser(string user, string password);
void LoginUser(string user, string password);
void LoginUser(string user, string password, bool isDomainUser);
void LoginUser(string user, string password, OnResultDelegate resultDelegate);
void LoginUser(string user, string password, bool isDomainUser, OnResultDelegate resultDelegate);
void LogoutUser();
void SetSecurityServer(string serverName);
bool CheckProjectAuthorization(string AuthorizationName);
List<string> GetProjectAuthorizations();
bool CheckAuthorizationGroup(string AuthorizationGroupName);
List<string> GetAuthorizationGroups();
bool CheckSystemAuthorization (string AuthorizationName);
List<string> GetSystemAuthorizations();
SecurityStatus GetSecurtityStatus();
string GetUserName();
int GetUserLevel();
void ChangePasswordAsAdmin(string user, string newPassword);
void ChangePasswordAsAdmin(string user, string newPassword);
void ChangePasswordAsAdmin(string user, string newPassword, bool isDomainUser);
void ChangePasswordAsAdmin(string user, string newPassword, OnResultDelegate resultDelegate);
void ChangePasswordAsAdmin(string user, string newPassword, bool isDomainUser,
OnResultDelegate resultDelegate);
void ChangePasswordAsUser(string oldPassword, string newPassword);
void ChangePasswordAsUser(string oldPassword, string newPassword);
void ChangePasswordAsUser(string oldPassword, string newPassword, bool isDomainUser);
void ChangePasswordAsUser(string oldPassword, string newPassword, OnResultDelegate resultDelegate);
void ChangePasswordAsUser(string oldPassword, string newPassword, bool isDomainUser,
OnResultDelegate resultDelegate);
event OnUserContextChangedEventHandler UserContextChanged;
void RegisterLanguageChangedHandler(string serverName, string[] symbolicNames,
OnLanguageChangedDelegate onLanguageChangedDelegate);
WFLanguage[] ReadLanguages(string serverName);
int GetLanguageId();
void SetLanguageId(int languageId);
void SetTranslationServer(string serverName);
void OutputDebugText(WFDebugLevel level, string textFormat,
params object[] textFormatParams);
event OnCommunicationErrorEventHandler CommunicationError;