XEP-0202: Entity Time

class slixmpp.plugins.xep_0202.XEP_0202(xmpp, config=None)

XEP-0202: Entity Time

default_config: ClassVar[Dict[str, Any]] = {'local_time': None, 'tz_offset': 0}

The basic, standard configuration for the plugin, which may be overridden when initializing the plugin. The configuration fields included here may be accessed directly as attributes of the plugin. For example, including the configuration field ‘foo’ would mean accessing plugin.foo returns the current value of plugin.config[‘foo’].

dependencies: ClassVar[Set[str]] = {'xep_0030', 'xep_0082'}

Some plugins may depend on others in order to function properly. Any plugin names included in dependencies will be initialized as needed if this plugin is enabled.

description: str = 'XEP-0202: Entity Time'

A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.

get_entity_time(to, ifrom=None, **iqargs)

Request the time from another entity.

Parameters:

to (JID) – JID of the entity to query.

name: str = 'xep_0202'

A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.

Stanza elements

class slixmpp.plugins.xep_0202.stanza.EntityTime(xml=None, parent=None)

The <time> element represents the local time for an XMPP agent. The time is expressed in UTC to make synchronization easier between entities, but the offset for the local timezone is also included.

Example <time> stanzas:

<iq type="result">
  <time xmlns="urn:xmpp:time">
    <utc>2011-07-03T11:37:12.234569</utc>
    <tzo>-07:00</tzo>
  </time>
</iq>

Stanza Interface:

time -- The local time for the entity (updates utc and tzo).
utc  -- The UTC equivalent to local time.
tzo  -- The local timezone offset from UTC.

del_time()

Remove both the UTC and TZO fields.

get_time()

Return the entity’s local time based on the UTC and TZO data.

get_tzo()

Return the timezone offset from UTC as a tzinfo object.

get_utc()

Return the time in UTC as a datetime object.

interfaces: ClassVar[Set[str]] = {'time', 'tzo', 'utc'}

The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name: ClassVar[str] = 'time'

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'urn:xmpp:time'

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

plugin_attrib: ClassVar[str] = 'entity_time'

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']

set_time(value)

Set both the UTC and TZO fields given a time object.

Parameters:

value – A datetime object or properly formatted string equivalent.

set_tzo(value)

Set the timezone offset from UTC.

Parameters:

value – Either a tzinfo object or the number of seconds (positive or negative) to offset.

set_utc(value)

Set the time in UTC.

Parameters:

value – A datetime object or properly formatted string equivalent.

sub_interfaces: ClassVar[Set[str]] = {'time', 'tzo', 'utc'}

A subset of interfaces which maps interfaces to direct subelements of the underlying XML object. Using this set, the text of these subelements may be set, retrieved, or removed without needing to define custom methods.