ExecuteLocalCommandInformation

The ExecuteLocalCommandInformation type is used hold information about a local command that can be passed between the UX and APIs.

Below are the properties and their purpose.

  • Guid SessionGUID
    • Default Value: Empty Guid.
    • Intended Value: The guid of the users current session.
  • Guid UserGUID
    • Default Value: Empty Guid.
    • Intended Value: The guid of the current user.
  • Guid CurrentInstanceGUID
    • Default Value: Empty Guid.
    • Intended Value: The guid of the instance the user is currently on.
  • Guid TargetInstanceGUID
    • Default Value: Empty Guid.
    • Intended Value: The guid of the instance the command should be executed on.
  • string CommandName
    • Default Value: Empty string.
    • Intended Value: The name of the command to execute.
  • string StringValue
    • Default Value: Empty string.
    • Intended Value: Contains either an A for add or R for remove an item from an instance.
  • string UserMessage
    • Default Value: Empty string.
    • Intended Value: Currently not being used.
  • string ErrorMessage
    • Default Value: Empty string.
    • Intended Value: A message detailing what failed in the API so the UX can properly handle the error.
Updated on January 25, 2023

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support

Leave a Comment