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
24 lines
710 B
ReStructuredText
24 lines
710 B
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vim.event.SessionEvent: ../../vim/event/SessionEvent.rst
|
|
|
|
|
|
vim.event.UserLoginSessionEvent
|
|
===============================
|
|
This event records a user logon.
|
|
:extends: vim.event.SessionEvent_
|
|
|
|
Attributes:
|
|
ipAddress (`str`_):
|
|
|
|
The IP address of the peer that initiated the connection. This may be the client that originated the session, or it may be an intervening proxy if the binding uses a protocol that supports proxies, such as HTTP.
|
|
userAgent (`str`_, optional):
|
|
|
|
The user agent or application
|
|
locale (`str`_):
|
|
|
|
The locale of the session.
|
|
sessionId (`str`_):
|
|
|
|
The unique identifier for the session.
|