Skip to content
Back to top
View this page

# XEP-0196: User Gaming

class slixmpp.plugins.xep_0196.XEP_0196(xmpp, config=None)

  XEP-0196: User Gaming

  dependencies: ClassVar[Set[str]] = {'xep_0163'}

    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-0196: User Gaming'

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

  name: str = 'xep_0196'

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

  publish_gaming(name=None, level=None, server_name=None, uri=None, character_name=None, character_profile=None, server_address=None, **pubsubkwargs)

    Publish the user’s current gaming status.

    Parameters:

      - name (`str` | `None`) – The name of the game.

      - level (`str` | `None`) – The user’s level in the game.

      - uri (`str` | `None`) – A URI for the game or relevant gaming service

      - server_name (`str` | `None`) – The name of the server where the user is playing.

      - server_address (`str` | `None`) – The hostname or IP address of the server where the user is playing.

      - character_name (`str` | `None`) – The name of the user’s character in the game.

      - character_profile (`str` | `None`) – A URI for a profile of the user’s character.

      - options – Optional form of publish options.

    Return type:

      `Future`

  stop(**pubsubkwargs)

    Clear existing user gaming information to stop notifications.

    Return type:

      `Future`

## Stanza elements

class slixmpp.plugins.xep_0196.stanza.UserGaming(xml=None, parent=None)
  interfaces: ClassVar[Set[str]] = {'character_name', 'character_profile', 'level', 'name', 'server_address', 'server_name', 'uri'}

    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] = 'game'

    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:gaming:0'

    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] = 'gaming'

    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']

  sub_interfaces: ClassVar[Set[str]] = {'character_name', 'character_profile', 'level', 'name', 'server_address', 'server_name', 'uri'}

    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.