Files
deb-python-pyvmomi/docs/vim/SimpleCommand.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

53 lines
1.2 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../vim/Task.rst
.. _VI API 2.5: ../vim/version.rst#vimversionversion2
.. _vim.SimpleCommand.Encoding: ../vim/SimpleCommand/Encoding.rst
.. _vim.ServiceManager.ServiceInfo: ../vim/ServiceManager/ServiceInfo.rst
vim.SimpleCommand
=================
A managed object that wraps the execution of a single arbitrary command. The specific command executed is assumed to be known from the service name by the client invoking this command. This object presents a generic interface for such services.
:since: `VI API 2.5`_
Attributes
----------
encodingType (`vim.SimpleCommand.Encoding`_):
The encoding type used in the result.
entity (`vim.ServiceManager.ServiceInfo`_):
A description of the service.
Methods
-------
ExecuteSimpleCommand(arguments):
The single function execution point for this simple command. The actual effects of this command depend upon the service handler registered for this instance.
Privilege:
Global.ServiceManagers
Args:
arguments (`str`_, optional):
An arbitrary collection of arguments.
Returns:
`str`_: