XEP-0447: Stateless File Sharing

XEP-0447 on xmpp.org

class slixmpp.plugins.xep_0447.XEP_0447(xmpp, config=None)[source]

XEP-0447: Stateless File Sharing

Only support outgoing SFS, incoming is not handled at all.

get_sfs(path=None, uris=None, media_type=None, desc=None, disposition=None, data=None, file=None)[source]
Overloads:

  • self, path (Path), uris (Iterable[str] | None), media_type (str | None), desc (str | None), disposition (Literal[‘inline’, ‘attachment’] | None), data (None), file (None) → stanza.StatelessFileSharing

  • self, path (None), uris (Iterable[str] | None), media_type (str | None), desc (str | None), disposition (Literal[‘inline’, ‘attachment’] | None), data (bytes), file (None) → stanza.StatelessFileSharing

  • self, path (None), uris (Iterable[str] | None), media_type (str | None), desc (str | None), disposition (Literal[‘inline’, ‘attachment’] | None), data (None), file (IO[bytes]) → stanza.StatelessFileSharing

Produce an SFS element from a file present locally.

Parameters:

  • path (Path | None) – Path of the file.

  • uris (Iterable[str] | None) – Iterable on uris to that file.

  • media_type (str | None) – Media type of the file.

  • desc (str | None) – Description of the file.

  • disposition (Literal['inline', 'attachment'] | None) – The content-disposition of the file.

Returns:

The SFS element.

Stanza elements

class slixmpp.plugins.xep_0447.stanza.Sources(xml=None, parent=None)[source]
name: ClassVar[str] = 'sources'

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:sfs: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] = 'sources'

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']
class slixmpp.plugins.xep_0447.stanza.StatelessFileSharing(xml=None, parent=None)[source]
interfaces: ClassVar[set[str]] = {'disposition'}

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] = 'file-sharing'

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:sfs: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] = 'sfs'

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']
class slixmpp.plugins.xep_0447.stanza.UrlData(xml=None, parent=None)[source]
interfaces: ClassVar[set[str]] = {'target'}

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] = 'url-data'

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 = 'http://jabber.org/protocol/url-data'

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] = 'url-data'

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