Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Classes

class ExtensionResult(**kwargs)

Depending on the context of the initialization, different parameters need to be passed to the constructor. See the notes below.

...

The default value is None.



Code Block
languagepy
themeConfluence
titleExample
>>> @dynamic_command('reset_environment')

...


>>> def reset_environment(self, fields):

...


>>>     # Implementation omitted

...


>>>     return ExtensionResult(

...


...         message = "Message: Hello from dynamic command 'reset_environment'!",

...


...         output = True,

...


...         output_data = 'The environment has been reset.',

...


...         output_name = 'DYNAMIC_OUTPUT'

...


...     )


Note

The form of the ExtensionResult constructor when instantiated in the context of Choice Command, is as follows:

Constructor Signature

(rc = 0, message = '', values = None, call_frame = None, **kwargs)

...

The default value is an empty list.

Example

>>> @dynamic_choice_command("primary_choice_field")

...

The default value is None.

Example

>>> def extension_start(self, fields):

...