Skip to content

FCPv2 FCPPluginReply

David Roden edited this page Jan 7, 2025 · 1 revision

FCPPluginReply is sent by the node to relay a plugin’s reply to an earlier FCPPluginMessage to the client.

Example

FCPPluginReply
Identifier=fcp-plugin-message-0001
PluginName=some.cool.Plugin
Replies.Param1=value1
Replies.Param2=value2
Success=true
EndMessage

Details

Field Possible values Description
Identifier any string The identifier of the initial FCPPluginMessage request.
PluginName the plugin’s class name The class name of the plugin sending the reply. 
Success [true, false] Whether the operation succeeded. If Success if false, ErrorCode and ErrorMessage may be set.
ErrorCode string An error code as specified by the plugin.
ErrorMessage string An error message from the plugin.
Replies.key string A key-value pair used by the plugin to transport properties to the client. Repeatable.

Clone this wiki locally