Message from add-in to Px5

Example

Method "RegisterAddin" without a payload:

{
"connectorversion": "1.0.0",
"addin": { "name": "My Px5-AddIn", "version": "0.1", "developer": "My Company" },
"method": "RegisterAddin",
"payload": null
}

Example

Method "ChangeInputValueInPx5" with ChangeInputValueInPx5Payload:

{
"connectorversion": "1.0.0",
"addin": { "name": "My Px5-AddIn", "version": "0.1", "developer": "My Company" },
"method": "ChangeInputValueInPx5",
"payload": {
"controlname": "Px5Feldname_Text",
"value": "My new value"
}
}

Example

Method "GetControlsFromPx5" without a payload:

{
"connectorversion": "1.0.0",
"addin": { "name": "My Px5-AddIn", "version": "0.1", "developer": "My Company" },
"method": "GetControlsFromPx5",
"payload": null
}

Example

Method "GetInfoFromPx5" without a payload:

{
"connectorversion": "1.0.0",
"addin": { "name": "My Px5-AddIn", "version": "0.1", "developer": "My Company" },
"method": "GetInfoFromPx5",
"payload": null
}

Example

Method "TriggerActionInPx5" with TriggerActionInPx5Payload:

{
"connectorversion": "1.0.0",
"addin": { "name": "My Px5-AddIn", "version": "0.1", "developer": "My Company" },
"method": "TriggerActionInPx5",
"payload": {
"action": "PerformButtonClick",
"controlname": "Px5Control"
}
}

Hierarchy

  • MessageToPx5

Properties

Informations about the add-in

connectorversion: string

Version of the Px5AddInConnector, that send the message

method: "RegisterAddin" | "ChangeInputValueInPx5" | "GetControlsFromPx5" | "GetInfoFromPx5" | "TriggerActionInPx5"

Method of the message:

  • RegisterAddin: Register Add-in in Px5, payload: null, triggered on creating new Px5AddInConnector instance
  • ChangeInputValueInPx5: Change value of a control in Px5 and triggers message "ValueChangedInPx5" on success, payload: ChangeInputValueInPx5Payload
  • GetControlsFromPx5: Triggers message "GetControlsFromPx5" on success, payload: null
  • GetInfoFromPx5: Triggers message "GetInfoFromPx5" on success, payload: null
  • TriggerActionInPx5: Triggers action in Px5, payload: TriggerActionInPx5Payload

Payload of the message

  • Method "ChangeInputValueInPx5": ChangeInputValueInPx5Payload
  • Method "TriggerActionInPx5": TriggerActionInPx5Payload
  • Methods "RegisterAddin", "GetControlsFromPx5", "GetInfoFromPx5": null