1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
########################################################################
# File name: __init__.py
# This file is part of: aioxmpp
#
# LICENSE
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program. If not, see
# <http://www.gnu.org/licenses/>.
#
########################################################################
"""
:mod:`~aioxmpp.pubsub` --- Publish-Subscribe support (:xep:`0060`)
##################################################################
This subpackage provides client-side support for :xep:`0060` publish-subscribe
services.
.. versionadded:: 0.6
Using Publish-Subscribe
=======================
To start using PubSub services in your application, you have to load the
:class:`.PubSubClient` into the client, using :meth:`~.node.Client.summon`.
.. currentmodule:: aioxmpp
.. autoclass:: PubSubClient
.. currentmodule:: aioxmpp.pubsub
.. class:: Service
Alias of :class:`.PubSubClient`.
.. deprecated:: 0.8
The alias will be removed in 1.0.
.. currentmodule:: aioxmpp.pubsub.xso
XSOs
====
Registering payloads
--------------------
PubSub payloads are must be registered at several places, so there is a
short-hand function to handle that:
.. autofunction:: as_payload_class
Features
--------
.. autoclass:: Feature
Generic namespace
-----------------
The top-level XSO is :class:`Request`. Below that, several different XSOs are
allowed, which are listed below the documentation of :class:`Request` in
alphabetical order.
.. autoclass:: Request
.. autoclass:: Affiliation
.. autoclass:: Affiliations
.. autoclass:: Configure
.. autoclass:: Create
.. autoclass:: Default
.. autoclass:: Item
.. autoclass:: Items
.. autoclass:: Options
.. autoclass:: Publish
.. autoclass:: Retract
.. autoclass:: Subscribe
.. autoclass:: SubscribeOptions
.. autoclass:: Subscription
.. autoclass:: Subscriptions
.. autoclass:: Unsubscribe
Owner namespace
---------------
The top-level XSO is :class:`OwnerRequest`. Below that, several different XSOs
are allowed, which are listed below the documentation of :class:`OwnerRequest`
in alphabetical order.
.. autoclass:: OwnerRequest
.. autoclass:: OwnerAffiliation
.. autoclass:: OwnerAffiliations
.. autoclass:: OwnerConfigure
.. autoclass:: OwnerDefault
.. autoclass:: OwnerDelete
.. autoclass:: OwnerPurge
.. autoclass:: OwnerRedirect
.. autoclass:: OwnerSubscription
.. autoclass:: OwnerSubscriptions
Application-condition error XSOs
--------------------------------
Application-condition XSOs for use in
:attr:`.stanza.Error.application_condition` are also defined for the error
conditions specified by :xep:`0060`. They are listed in alphabetical order
below:
.. autoclass:: ClosedNode()
.. autoclass:: ConfigurationRequired()
.. autoclass:: InvalidJID()
.. autoclass:: InvalidOptions()
.. autoclass:: InvalidPayload()
.. autoclass:: InvalidSubID()
.. autoclass:: ItemForbidden()
.. autoclass:: ItemRequired()
.. autoclass:: JIDRequired()
.. autoclass:: MaxItemsExceeded()
.. autoclass:: MaxNodesExceeded()
.. autoclass:: NodeIDRequired()
.. autoclass:: NotInRosterGroup()
.. autoclass:: NotSubscribed()
.. autoclass:: PayloadTooBig()
.. autoclass:: PayloadRequired()
.. autoclass:: PendingSubscription()
.. autoclass:: PresenceSubscriptionRequired()
.. autoclass:: SubIDRequired()
.. autoclass:: TooManySubscriptions()
.. autoclass:: Unsupported()
Forms
-----
.. currentmodule:: aioxmpp.pubsub
.. autoclass:: NodeConfigForm
"""
from .service import PubSubClient # NOQA: F401
from .xso import NodeConfigForm # NOQA: F401
Service = PubSubClient
|
