Files

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

2.3 KiB

Raw Blame History

vim.vm.Message

Message data which is intended to be displayed according to the locale of a client.A VirtualMachineMessage contains both a formatted, localized version of the text and the data needed to perform localization in conjunction with localization catalogs.Clients of the VIM API may use SessionManager . SetLocale to cause the server to emit localized text , or may perform client-side localization based on message catalogs provided by the LocalizationManager .Message variables are always integers, e.g. {1} and {2}, which are 1-based indexes into argument .

The corresponding argument may be a recursive lookup:

argument

= ["button.cancel", "msg.revert"]

CATALOG(locmsg,

id

) = "Select '{1}' to {2}"

CATALOG(locmsg, button.cancel) = "Cancel"

CATALOG(locmsg, msg.revert) = "revert"

==

text

= "Select 'Cancel' to revert"

If the recursive lookup fails, the argument is a plain string.

argument

= ["127.0.0.1"]

CATALOG(locmsg,

id

) = "IP address is {1}"

==

text

"IP address is 127.0.0.1"See LocalizationManager

extends: vmodl.DynamicData
since: VI API 2.5

Attributes:

id (str):

A unique identifier for this particular message. This field is a key for looking up format strings in the locmsg catalog.

argument (object, optional):

Substitution arguments for variables in the localized message. Substitution variables in the format string identified by id are 1-based indexes into this array. Substitution variable {1} corresponds to argument[0], etc.

text (str, optional):

Text in session locale. Use SessionManager . SetLocale to change the session locale.

2.3 KiB Raw Blame History

vim.vm.Message

2.3 KiB

Raw Blame History