Type: BCS.Sym3.Operator.Runtime.ISym3OperatorClient

Sym3 Operator Client - In a macro you get access to this by using the variable called ‘Client’

Properties

Alarms

  • Description: Access the alarm service
  • Type: IAlarmClientService
  • Access: Read

Authentication

  • Description: Access the authentication service
  • Type: IAuthenticationService
  • Access: Read

Connections

  • Description: Access the connection service
  • Type: IConnectionService
  • Access: Read

CurrentLanguage

  • Description: Gets/Sets current language
  • Type: ILanguage
  • Access: Read and Write

Debug

  • Description: Access the debug service
  • Type: IDebugService
  • Access: Read

Events

  • Description: Access the event log service
  • Type: IEventLogService
  • Access: Read

Layout

  • Description: Access the layout service
  • Type: ILayoutService
  • Access: Read

LogFilePath

  • Description: Gets the log file path
  • Type: String
  • Access: Read

Logger

  • Description: Gets the logger
  • Type: ILogger
  • Access: Read

MaxNumberOfAlarms

  • Description: get max number of alarms this client can receive
  • Type: Int32
  • Access: Read

MaxNumberOfEvents

  • Description: get max number of events this client can receive
  • Type: Int32
  • Access: Read

Products

  • Description: Access the product service
  • Type: IProductService
  • Access: Read

Project

  • Description: Gets the project - The project is read only
  • Type: ISym3Project
  • Access: Read

Scripting

  • Description: Access the Scripting service
  • Type: IScriptingService
  • Access: Read

Settings

  • Description: Access client global settings
  • Type: IClientSettings
  • Access: Read

Tags

  • Description: Access the tag service
  • Type: ITagService
  • Access: Read

Tools

  • Description: Gets access to some useful tools
  • Type: ISym3Tools
  • Access: Read

Methods

DecreaseVolume

Decreases sound volume

Exit(System.Boolean)

Exit client application

  • Parameters:
    • displayConfirmationMessage: if true, a confirmation message will pop up.

FireUserActivity(System.Object,BCS.Sym3.Operator.Runtime.UserActivityType,System.Object[])

Fire a new user activity

  • Parameters:
    • source: source object
    • type: type of activity
    • args: array of arguments. These arguments depends on the type

IncreaseVolume

Increases sound volume

MuteVolume

Mute sounds

Restart

Restart client applciation

Events

ClientStarted This event is fired when the client starts

  • Example:
This example shows you how to subscribe to this event


             //---- JAVASCRIPT:
             Client.add_ClientStarted(OnStart);
             
             function OnStart() {
             ...
             }
             
             //---- C#:
             Client.ClientStarted += new ClientStartStopEventHandler(OnClientStarted);
             ...
             
             private void OnClientStarted()
             {
                 // TODO...
             }

ClientStopped This event is fired when the client stops

  • Example:
This example shows you how to subscribe to this event


             //---- JAVASCRIPT:
             Client.add_ClientStopped(OnStop);
             
             function OnStop() {
             ...
             }
             
             //---- C#:
             Client.ClientStopped += new ClientStartStopEventHandler(OnClientStopped);
             ...
             
             private void OnClientStopped()
             {
                 // TODO...
             }

UserActivity This event is fired when the user did something.

  • Example:
This example shows you how to subscribe to this event


             //---- JAVASCRIPT:
             Client.add_UserActivity(OnUserActivity);
             
             function OnUserActivity(source, type, args) {
             
                 if(type == BCS.Sym3.Operator.Runtime.UserActivityType.ButtonClicked) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.MenuItemClicked) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.HotKeyPressed) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.CurrentUserChanged) { ... }
                 else if(type == BCS.Sym3.Operator.Runtime.UserActivityType.ValueChanged) { ... }
             }
             
             //---- C#:
             Client.UserActivity += new ActivityEventHandler(OnUserActivity);
             ...
             
             private void OnUserActivity(object source, UserActivityType type, params object[] args)
             {
                 // TODO...
             }