Changeset 166:d9c10a5b5c0d for wokkel


Ignore:
Timestamp:
Jan 23, 2012, 3:48:48 PM (8 years ago)
Author:
Ralph Meijer <ralphm@…>
Branch:
default
Message:

Documentation fixes for pydoctor.

Location:
wokkel
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • wokkel/component.py

    r165 r166  
    7676
    7777    @ivar domains: Domains (as C{str}) this component will handle traffic for.
    78     @type domains: L{set}
     78    @type domains: C{set}
    7979    """
    8080
    … …  
    251251
    252252    @ivar routes: Routes based on the host part of JIDs. Maps host names to the
    253                   L{EventDispatcher<utility.EventDispatcher>}s that should
    254                   receive the traffic. A key of C{None} means the default
    255                   route.
     253        L{EventDispatcher<twisted.words.xish.utility.EventDispatcher>}s that
     254        should receive the traffic. A key of C{None} means the default route.
    256255    @type routes: C{dict}
    257256    """
    … …  
    271270        @param destination: Destination of the route to be added as a host name
    272271                            or C{None} for the default route.
    273         @type destination: C{str} or C{NoneType}.
     272        @type destination: C{str} or C{NoneType}
     273
    274274        @param xs: XML Stream to register the route for.
    275         @type xs: L{EventDispatcher<utility.EventDispatcher>}.
     275        @type xs:
     276            L{EventDispatcher<twisted.words.xish.utility.EventDispatcher>}
    276277        """
    277278        self.routes[destination] = xs
    … …  
    285286        @param destination: Destination of the route that should be removed.
    286287        @type destination: C{str}.
     288
    287289        @param xs: XML Stream to remove the route for.
    288         @type xs: L{EventDispatcher<utility.EventDispatcher>}.
     290        @type xs:
     291            L{EventDispatcher<twisted.words.xish.utility.EventDispatcher>}
    289292        """
    290293        xs.removeObserver('/*', self.route)

  • wokkel/disco.py

    r165 r166  
    456456    Protocol implementation for XMPP Service Discovery.
    457457
    458     This handler will listen to XMPP service discovery requests and
    459     query the other handlers in L{parent} (see L{XMPPHandlerContainer}) for
    460     their identities, features and items according to L{IDisco}.
     458    This handler will listen to XMPP service discovery requests and query the
     459    other handlers in C{parent} (see
     460    L{twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection})
     461    for their identities, features and items according to L{IDisco}.
    461462    """
    462463

  • wokkel/iwokkel.py

    r165 r166  
    4242
    4343        @param requestor: The entity the request originated from.
    44         @type requestor: L{jid.JID}
     44        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
    4545        @param target: The target entity to which the request is made.
    46         @type target: L{jid.JID}
     46        @type target: L{JID<twisted.words.protocols.jabber.jid.JID>}
     47        @param nodeIdentifier: The optional identifier of the node at this
     48            entity to retrieve the identify and features of.  The default is
     49            C{''}, meaning the root node.
     50        @type nodeIdentifier: C{unicode}
     51        """
     52
     53    def getDiscoItems(requestor, target, nodeIdentifier=''):
     54        """
     55        Get contained items for this entity, node.
     56
     57        @param requestor: The entity the request originated from.
     58        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     59        @param target: The target entity to which the request is made.
     60        @type target: L{JID<twisted.words.protocols.jabber.jid.JID>}
    4761        @param nodeIdentifier: The optional identifier of the node at this
    4862                               entity to retrieve the identify and features of.
    … …  
    5165        """
    5266
    53     def getDiscoItems(requestor, target, nodeIdentifier=''):
    54         """
    55         Get contained items for this entity, node.
    56 
    57         @param requestor: The entity the request originated from.
    58         @type requestor: L{jid.JID}
    59         @param target: The target entity to which the request is made.
    60         @type target: L{jid.JID}
    61         @param nodeIdentifier: The optional identifier of the node at this
    62                                entity to retrieve the identify and features of.
    63                                The default is C{''}, meaning the root node.
    64         @type nodeIdentifier: C{unicode}
    65         """
    66 
    6767
    6868
    … …  
    107107
    108108        @param service: The publish-subscribe service entity.
    109         @type service: L{jid.JID}
     109        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    110110        @param nodeIdentifier: Optional suggestion for the new node's
    111111                               identifier. If omitted, the creation of an
    112112                               instant node will be attempted.
    113         @type nodeIdentifier: L{unicode}
     113        @type nodeIdentifier: C{unicode}
    114114        @return: a deferred that fires with the identifier of the newly created
    115115                 node. Note that this can differ from the suggested identifier
    116116                 if the publish subscribe service chooses to modify or ignore
    117117                 the suggested identifier.
    118         @rtype: L{defer.Deferred}
     118        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    119119        """
    120120
    … …  
    124124
    125125        @param service: The publish-subscribe service entity.
    126         @type service: L{jid.JID}
     126        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    127127        @param nodeIdentifier: Identifier of the node to be deleted.
    128         @type nodeIdentifier: L{unicode}
    129         @rtype: L{defer.Deferred}
     128        @type nodeIdentifier: C{unicode}
     129        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    130130        """
    131131
    … …  
    135135
    136136        @param service: The publish-subscribe service entity.
    137         @type service: L{jid.JID}
     137        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    138138        @param nodeIdentifier: Identifier of the node to subscribe to.
    139         @type nodeIdentifier: L{unicode}
     139        @type nodeIdentifier: C{unicode}
    140140        @param subscriber: JID to subscribe to the node.
    141         @type subscriber: L{jid.JID}
    142         @rtype: L{defer.Deferred}
     141        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
     142        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    143143        """
    144144
    … …  
    148148
    149149        @param service: The publish-subscribe service entity.
    150         @type service: L{jid.JID}
     150        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    151151        @param nodeIdentifier: Identifier of the node to unsubscribe from.
    152         @type nodeIdentifier: L{unicode}
     152        @type nodeIdentifier: C{unicode}
    153153        @param subscriber: JID to unsubscribe from the node.
    154         @type subscriber: L{jid.JID}
    155         @rtype: L{defer.Deferred}
     154        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
     155        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    156156        """
    157157
    … …  
    165165
    166166        @param service: The publish-subscribe service entity.
    167         @type service: L{jid.JID}
     167        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    168168        @param nodeIdentifier: Identifier of the node to publish to.
    169         @type nodeIdentifier: L{unicode}
     169        @type nodeIdentifier: C{unicode}
    170170        @param items: List of item elements.
    171         @type items: L{list} of L{Item}
    172         @rtype: L{defer.Deferred}
     171        @type items: C{list} of L{Item}
     172        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    173173        """
    174174
    … …  
    190190
    191191        @param service: The entity the notifications will originate from.
    192         @type service: L{jid.JID}
     192        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    193193        @param nodeIdentifier: The identifier of the node that was published
    194                                to.
     194            to.
    195195        @type nodeIdentifier: C{unicode}
    196196        @param notifications: The notifications as tuples of subscriber, the
    197                               list of subscriptions and the list of items to be
    198                               notified.
    199         @type notifications: C{list} of (L{jid.JID}, C{list} of
    200                              L{Subscription<wokkel.pubsub.Subscription>},
    201                              C{list} of L{domish.Element})
     197            list of subscriptions and the list of items to be notified.
     198        @type notifications: C{list} of
     199            (L{JID<twisted.words.protocols.jabber.jid.JID>}, C{list} of
     200            L{Subscription<wokkel.pubsub.Subscription>}, C{list} of
     201            L{Element<twisted.words.xish.domish.Element>})
    202202        """
    203203
    … …  
    209209
    210210        @param service: The entity the notifications will originate from.
    211         @type service: L{jid.JID}
     211        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    212212        @param nodeIdentifier: The identifier of the node that was deleted.
    213213        @type nodeIdentifier: C{unicode}
    214         @param subscribers: The subscribers for which a notification should
    215                             be sent out.
    216         @type subscribers: C{list} of L{jid.JID}
     214        @param subscribers: The subscribers for which a notification should be
     215            sent out.
     216        @type subscribers: C{list} of
     217            L{JID<twisted.words.protocols.jabber.jid.JID>}
    217218        @param redirectURI: Optional XMPP URI of another node that subscribers
    218                             are redirected to.
     219            are redirected to.
    219220        @type redirectURI: C{str}
    220221        """
    … …  
    225226
    226227        @param requestor: The entity the request originated from.
    227         @type requestor: L{jid.JID}
    228         @param service: The entity the request was addressed to.
    229         @type service: L{jid.JID}
     228        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     229        @param service: The entity the request was addressed to.
     230        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    230231        @param nodeIdentifier: The identifier of the node to publish to.
    231232        @type nodeIdentifier: C{unicode}
    232         @param items: The items to be published as L{domish} elements.
    233         @type items: C{list} of C{domish.Element}
     233        @param items: The items to be published as elements.
     234        @type items: C{list} of C{Element<twisted.words.xish.domish.Element>}
    234235        @return: deferred that fires on success.
    235         @rtype: L{defer.Deferred}
     236        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    236237        """
    237238
    … …  
    241242
    242243        @param requestor: The entity the request originated from.
    243         @type requestor: L{jid.JID}
    244         @param service: The entity the request was addressed to.
    245         @type service: L{jid.JID}
     244        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     245        @param service: The entity the request was addressed to.
     246        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    246247        @param nodeIdentifier: The identifier of the node to subscribe to.
    247248        @type nodeIdentifier: C{unicode}
    248249        @param subscriber: The entity to be subscribed.
    249         @type subscriber: L{jid.JID}
     250        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    250251        @return: A deferred that fires with a
    251252                 L{Subscription<wokkel.pubsub.Subscription>}.
    252         @rtype: L{defer.Deferred}
     253        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    253254        """
    254255
    … …  
    258259
    259260        @param requestor: The entity the request originated from.
    260         @type requestor: L{jid.JID}
    261         @param service: The entity the request was addressed to.
    262         @type service: L{jid.JID}
     261        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     262        @param service: The entity the request was addressed to.
     263        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    263264        @param nodeIdentifier: The identifier of the node to unsubscribe from.
    264265        @type nodeIdentifier: C{unicode}
    265266        @param subscriber: The entity to be unsubscribed.
    266         @type subscriber: L{jid.JID}
     267        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    267268        @return: A deferred that fires with C{None} when unsubscription has
    268269                 succeeded.
    269         @rtype: L{defer.Deferred}
     270        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    270271        """
    271272
    … …  
    275276
    276277        @param requestor: The entity the request originated from.
    277         @type requestor: L{jid.JID}
    278         @param service: The entity the request was addressed to.
    279         @type service: L{jid.JID}
     278        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     279        @param service: The entity the request was addressed to.
     280        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    280281        @return: A deferred that fires with a C{list} of subscriptions as
    281282                 L{Subscription<wokkel.pubsub.Subscription>}.
    282         @rtype: L{defer.Deferred}
     283        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    283284        """
    284285
    … …  
    288289
    289290        @param requestor: The entity the request originated from.
    290         @type requestor: L{jid.JID}
    291         @param service: The entity the request was addressed to.
    292         @type service: L{jid.JID}
     291        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     292        @param service: The entity the request was addressed to.
     293        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    293294        @return: A deferred that fires with a C{list} of affiliations as
    294                  C{tuple}s of (node identifier as C{unicode}, affiliation state
    295                  as C{str}). The affiliation can be C{'owner'}, C{'publisher'},
    296                  or C{'outcast'}.
    297         @rtype: L{defer.Deferred}
     295            C{tuple}s of (node identifier as C{unicode}, affiliation state as
     296            C{str}). The affiliation can be C{'owner'}, C{'publisher'}, or
     297            C{'outcast'}.
     298        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    298299        """
    299300
    … …  
    303304
    304305        @param requestor: The entity the request originated from.
    305         @type requestor: L{jid.JID}
    306         @param service: The entity the request was addressed to.
    307         @type service: L{jid.JID}
    308         @param nodeIdentifier: The suggestion for the identifier of the node to
    309                                be created. If the request did not include a
    310                                suggestion for the node identifier, the value
    311                                is C{None}.
     306        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     307        @param service: The entity the request was addressed to.
     308        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
     309        @param nodeIdentifier: The suggestion for the identifier of the node
     310            to be created. If the request did not include a suggestion for the
     311            node identifier, the value is C{None}.
    312312        @type nodeIdentifier: C{unicode} or C{NoneType}
    313313        @return: A deferred that fires with a C{unicode} that represents
    314314                 the identifier of the new node.
    315         @rtype: L{defer.Deferred}
     315        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    316316        """
    317317
    … …  
    356356
    357357        @param requestor: The entity the request originated from.
    358         @type requestor: L{jid.JID}
    359         @param service: The entity the request was addressed to.
    360         @type service: L{jid.JID}
     358        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     359        @param service: The entity the request was addressed to.
     360        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    361361        @param nodeType: The type of node for which the configuration is
    362362                         retrieved, C{'leaf'} or C{'collection'}.
    … …  
    366366                 field name. Values can be of types C{unicode}, C{int} or
    367367                 C{bool}.
    368         @rtype: L{defer.Deferred}
     368        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    369369        """
    370370
    … …  
    374374
    375375        @param requestor: The entity the request originated from.
    376         @type requestor: L{jid.JID}
    377         @param service: The entity the request was addressed to.
    378         @type service: L{jid.JID}
     376        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     377        @param service: The entity the request was addressed to.
     378        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    379379        @param nodeIdentifier: The identifier of the node to retrieve the
    380380                               configuration from.
    381381        @type nodeIdentifier: C{unicode}
    382382        @return: A deferred that fires with a C{dict} representing the node
    383                  configuration. Keys are C{str}s that represent the field name.
    384                  Values can be of types C{unicode}, C{int} or C{bool}.
    385         @rtype: L{defer.Deferred}
     383            configuration. Keys are C{str}s that represent the field name.
     384            Values can be of types C{unicode}, C{int} or C{bool}.
     385        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    386386        """
    387387
    … …  
    391391
    392392        @param requestor: The entity the request originated from.
    393         @type requestor: L{jid.JID}
    394         @param service: The entity the request was addressed to.
    395         @type service: L{jid.JID}
     393        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     394        @param service: The entity the request was addressed to.
     395        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    396396        @param nodeIdentifier: The identifier of the node to change the
    397397                               configuration of.
    … …  
    399399        @return: A deferred that fires with C{None} when the node's
    400400                 configuration has been changed.
    401         @rtype: L{defer.Deferred}
     401        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    402402        """
    403403
    … …  
    407407
    408408        @param requestor: The entity the request originated from.
    409         @type requestor: L{jid.JID}
    410         @param service: The entity the request was addressed to.
    411         @type service: L{jid.JID}
     409        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     410        @param service: The entity the request was addressed to.
     411        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    412412        @param nodeIdentifier: The identifier of the node to retrieve items
    413413                               from.
    … …  
    420420
    421421        @param requestor: The entity the request originated from.
    422         @type requestor: L{jid.JID}
    423         @param service: The entity the request was addressed to.
    424         @type service: L{jid.JID}
     422        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     423        @param service: The entity the request was addressed to.
     424        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    425425        @param nodeIdentifier: The identifier of the node to retract items
    426426                               from.
    … …  
    433433
    434434        @param requestor: The entity the request originated from.
    435         @type requestor: L{jid.JID}
    436         @param service: The entity the request was addressed to.
    437         @type service: L{jid.JID}
     435        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     436        @param service: The entity the request was addressed to.
     437        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    438438        @param nodeIdentifier: The identifier of the node to be purged.
    439439        @type nodeIdentifier: C{unicode}
    … …  
    445445
    446446        @param requestor: The entity the request originated from.
    447         @type requestor: L{jid.JID}
    448         @param service: The entity the request was addressed to.
    449         @type service: L{jid.JID}
     447        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
     448        @param service: The entity the request was addressed to.
     449        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    450450        @param nodeIdentifier: The identifier of the node to be delete.
    451451        @type nodeIdentifier: C{unicode}
    … …  
    470470
    471471        @param requestor: The entity the request originated from.
    472         @type requestor: L{jid.JID}
     472        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
    473473        @param service: The publish-subscribe service entity.
    474         @type service: L{jid.JID}
     474        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    475475        @param nodeIdentifier: Identifier of the node to request the info for.
    476         @type nodeIdentifier: L{unicode}
     476        @type nodeIdentifier: C{unicode}
    477477        @return: A deferred that fires with a dictionary. If not empty,
    478478                 it must have the keys C{'type'} and C{'meta-data'} to keep
    479479                 respectively the node type and a dictionary with the meta
    480480                 data for that node.
    481         @rtype: L{defer.Deferred}
     481        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    482482        """
    483483
    … …  
    488488
    489489        @param requestor: The entity the request originated from.
    490         @type requestor: L{jid.JID}
     490        @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
    491491        @param service: The publish-subscribe service entity.
    492         @type service: L{jid.JID}
    493         @param nodeIdentifier: Identifier of the node to request the childs for.
    494         @type nodeIdentifier: L{unicode}
     492        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
     493        @param nodeIdentifier: Identifier of the node to request the childs
     494            for.
     495        @type nodeIdentifier: C{unicode}
    495496        @return: A deferred that fires with a list of child node identifiers.
    496         @rtype: L{defer.Deferred}
     497        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    497498        """
    498499
    … …  
    541542        @type request: L{wokkel.pubsub.PubSubRequest}
    542543        @return: deferred that fires on success.
    543         @rtype: L{defer.Deferred}
     544        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    544545        """
    545546
    … …  
    553554        @return: A deferred that fires with a
    554555                 L{Subscription<wokkel.pubsub.Subscription>}.
    555         @rtype: L{defer.Deferred}
     556        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    556557        """
    557558
    … …  
    565566        @return: A deferred that fires with C{None} when unsubscription has
    566567                 succeeded.
    567         @rtype: L{defer.Deferred}
     568        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    568569        """
    569570
    … …  
    577578        @return: A deferred that fires with a C{list} of subscriptions as
    578579                 L{Subscription<wokkel.pubsub.Subscription>}.
    579         @rtype: L{defer.Deferred}
     580        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    580581        """
    581582
    … …  
    588589        @type request: L{wokkel.pubsub.PubSubRequest}
    589590        @return: A deferred that fires with a C{list} of affiliations as
    590                  C{tuple}s of (node identifier as C{unicode}, affiliation state
    591                  as C{str}). The affiliation can be C{'owner'}, C{'publisher'},
    592                  or C{'outcast'}.
    593         @rtype: L{defer.Deferred}
     591            C{tuple}s of (node identifier as C{unicode}, affiliation state as
     592            C{str}). The affiliation can be C{'owner'}, C{'publisher'}, or
     593            C{'outcast'}.
     594        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    594595        """
    595596
    … …  
    603604        @return: A deferred that fires with a C{unicode} that represents
    604605                 the identifier of the new node.
    605         @rtype: L{defer.Deferred}
     606        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    606607        """
    607608
    … …  
    617618                 field name. Values can be of types C{unicode}, C{int} or
    618619                 C{bool}.
    619         @rtype: L{defer.Deferred}
     620        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    620621        """
    621622
    … …  
    628629        @type request: L{wokkel.pubsub.PubSubRequest}
    629630        @return: A deferred that fires with a C{dict} representing the node
    630                  configuration. Keys are C{str}s that represent the field name.
    631                  Values can be of types C{unicode}, C{int} or C{bool}.
    632         @rtype: L{defer.Deferred}
     631            configuration. Keys are C{str}s that represent the field name.
     632            Values can be of types C{unicode}, C{int} or C{bool}.
     633        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    633634        """
    634635
    … …  
    642643        @return: A deferred that fires with C{None} when the node's
    643644                 configuration has been changed.
    644         @rtype: L{defer.Deferred}
     645        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    645646        """
    646647
    … …  
    653654        @type request: L{wokkel.pubsub.PubSubRequest}
    654655        @return: A deferred that fires with a C{list} of L{pubsub.Item}.
    655         @rtype: L{defer.Deferred}
     656        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    656657        """
    657658
    … …  
    665666        @return: A deferred that fires with C{None} when the given items have
    666667                 been retracted.
    667         @rtype: L{defer.Deferred}
     668        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    668669        """
    669670
    … …  
    677678        @return: A deferred that fires with C{None} when the node has been
    678679                 purged.
    679         @rtype: L{defer.Deferred}
     680        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    680681        """
    681682
    … …  
    689690        @return: A deferred that fires with C{None} when the node has been
    690691                 deleted.
    691         @rtype: L{defer.Deferred}
     692        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    692693        """
    693694
    … …  
    695696    def affiliationsGet(request):
    696697        """
    697         Called when a affiliations retrieval request (owner) has been received.
     698        Called when an owner affiliations retrieval request been received.
    698699
    699700        @param request: The publish-subscribe request.
    700701        @type request: L{wokkel.pubsub.PubSubRequest}
    701702        @return: A deferred that fires with a C{dict} of affiliations with the
    702             entity as key (L{JID}) and the affiliation state as value
    703             (C{unicode}).  The affiliation can be C{u'owner'}, C{u'publisher'},
    704             or C{u'outcast'}.
    705         @rtype: L{defer.Deferred}
     703            entity as key (L{JID<twisted.words.protocols.jabber.jid.JID>}) and
     704            the affiliation state as value (C{unicode}).  The affiliation can
     705            be C{u'owner'}, C{u'publisher'}, or C{u'outcast'}.
     706        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    706707
    707708        @note: Affiliations are always on the bare JID. An implementation of
    … …  
    716717        @param request: The publish-subscribe request.
    717718        @type request: L{wokkel.pubsub.PubSubRequest}
     719
    718720        @return: A deferred that fires with C{None} when the affiliation
    719721            changes were succesfully processed..
    720         @rtype: L{defer.Deferred}
     722        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    721723
    722724        @note: Affiliations are always on the bare JID. The JIDs in
    723         L{wokkel.pubsub.PubSubRequest.affiliations} are already stripped of
    724         any resource.
     725            L{wokkel.pubsub.PubSubRequest}'s C{affiliations} attribute are
     726            already stripped of any resource.
    725727        """
    726728
    … …  
    736738    def receivedSubject(room, user, subject):
    737739        """
    738         A subject is received when you join a room and when the subject is changed. This
    739         method is triggered by one of those two events.
     740        The room subject has been received.
     741
     742        A subject is received when you join a room and when the subject is
     743        changed.
    740744
    741745        @param room: The room the subject was accepted for.
    … …  
    752756    def receivedHistory(room, user, message):
    753757        """
    754         Past messages from a chat room has been received. This occurs when you join a room.
     758        Past messages from a chat room have been received.
     759
     760        This occurs when you join a room.
    755761        """
    756762
    … …  
    761767
    762768        @param roomJID: The room to configure.
    763         @type roomJID: L{jid.JID}
    764 
    765         @param options: A mapping of field names to values, or C{None} to cancel.
     769        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
     770
     771        @param options: A mapping of field names to values, or C{None} to
     772            cancel.
    766773        @type options: C{dict}
    767774        """
    … …  
    775782
    776783        @param roomJID: The bare JID of the room.
    777         @type roomJID: L{jid.JID}
     784        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    778785
    779786        @return: A deferred that fires with the room's configuration form as
    … …  
    788795
    789796        @param roomJID: The JID of the room the entity is joining.
    790         @type roomJID: L{jid.JID}
     797        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    791798
    792799        @param nick: The nick name for the entitity joining the room.
    … …  
    812819
    813820        @param roomJID: The JID of the room, i.e. without a resource.
    814         @type roomJID: L{jid.JID}
     821        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    815822
    816823        @param nick: The new nick name within the room.
    … …  
    826833
    827834        @param roomJID: The Room JID of the room to leave.
    828         @type roomJID: L{jid.JID}
     835        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    829836        """
    830837
    … …  
    858865
    859866        @param occupantJID: The Room JID of the other user.
    860         @type occupantJID: L{jid.JID}
     867        @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    861868        """
    862869
    … …  
    867874
    868875        @param roomJID: The bare JID of the room.
    869         @type roomJID: L{jid.JID}
     876        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    870877
    871878        @param options: A mapping of field names to values, or C{None} to
    … …  
    882889
    883890        @param roomJID: The bare JID of the room.
    884         @type roomJID: L{jid.JID}
     891        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    885892
    886893        @param subject: The subject you want to set.
    … …  
    894901
    895902        @param roomJID: The room jabber/xmpp entity id.
    896         @type roomJID: L{jid.JID}
     903        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    897904        """
    898905
    … …  
    905912
    906913        @param roomJID: The room jabber/xmpp entity id.
    907         @type roomJID: L{jid.JID}
     914        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    908915
    909916        @param messages: The history to send to the room as an ordered list of
    910                          message, represented by a dictionary with the keys
    911                          C{'stanza'}, holding the original stanza a
    912                          L{domish.Element}, and C{'timestamp'} with the
    913                          timestamp.
    914         @type messages: L{list} of L{domish.Element}
     917            message, represented by a dictionary with the keys C{'stanza'},
     918            holding the original stanza a
     919            L{Element<twisted.words.xish.domish.Element>}, and C{'timestamp'}
     920            with the timestamp.
     921        @type messages: C{list} of
     922            L{Element<twisted.words.xish.domish.Element>}
    915923        """
    916924
    … …  
    921929
    922930        @param roomJID: The bare JID of the room.
    923         @type roomJID: L{jid.JID}
     931        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    924932
    925933        @param entity: The bare JID of the entity to be banned.
    926         @type entity: L{jid.JID}
     934        @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
    927935
    928936        @param reason: The reason for banning the entity.
    … …  
    930938
    931939        @param sender: The entity sending the request.
    932         @type sender: L{jid.JID}
     940        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    933941        """
    934942
    … …  
    939947
    940948        @param roomJID: The bare JID of the room.
    941         @type roomJID: L{jid.JID}
     949        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    942950
    943951        @param nick: The occupant to be banned.
    944         @type nick: L{jid.JID} or C{unicode}
     952        @type nick: L{JID<twisted.words.protocols.jabber.jid.JID>} or
     953            C{unicode}
    945954
    946955        @param reason: The reason given for the kick.
    … …  
    948957
    949958        @param sender: The entity sending the request.
    950         @type sender: L{jid.JID}
     959        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    951960        """
    952961

  • wokkel/muc.py

    r162 r166  
    228228
    229229    @param alternate: Optional room JID of an alternate venue.
    230     @type alternate: L{jid.JID}
     230    @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
    231231
    232232    @param password: Optional password for entering the alternate venue.
    … …  
    398398
    399399    @ivar entity: The real JID of the entity this presence is from.
    400     @type entity: L{jid.JID}
     400    @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
    401401
    402402    @ivar mucStatuses: Set of one or more status codes from L{STATUS_CODE}.
    … …  
    500500        Called when the XML stream has been initialized.
    501501
    502         It initializes several XPath events to handle MUC stanzas that come in.
    503         After those are initialized the method L{initialized} is called to
    504         signal that we have finished.
     502        It initializes several XPath events to handle MUC stanzas that come
     503        in.
    505504        """
    506505        xmppim.BasePresenceProtocol.connectionInitialized(self)
    … …  
    547546        @param timeout: The number of seconds to wait before the deferred is
    548547            timed out.
    549         @type timeout: L{int}
     548        @type timeout: C{int}
    550549
    551550        The deferred object L{defer.Deferred} is returned.
    … …  
    590589
    591590        @param roomJID: The JID of the room the entity is joining.
    592         @type roomJID: L{jid.JID}
     591        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    593592
    594593        @param nick: The nick name for the entitity joining the room.
    … …  
    623622
    624623        @param roomJID: The JID of the room.
    625         @type roomJID: L{jid.JID}
     624        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    626625
    627626        @param nick: The new nick name within the room.
    … …  
    640639
    641640        @param roomJID: The Room JID of the room.
    642         @type roomJID: L{jid.JID}
     641        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    643642
    644643        @param show: The availability of the entity. Common values are xa,
    … …  
    662661
    663662        @param roomJID: The JID of the room.
    664         @type roomJID: L{jid.JID}
     663        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    665664        """
    666665        occupantJID = self._roomOccupantMap[roomJID]
    … …  
    686685
    687686        @param occupantJID: The Room JID of the other user.
    688         @type occupantJID: L{jid.JID}
     687        @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    689688        """
    690689        message = PrivateChat(recipient=occupantJID, body=body)
    … …  
    699698
    700699        @param roomJID: The bare JID of the room.
    701         @type roomJID: L{jid.JID}
     700        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    702701
    703702        @param subject: The subject you want to set.
    … …  
    715714
    716715        @param roomJID: The bare JID of the room.
    717         @type roomJID: L{jid.JID}
     716        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    718717
    719718        @param invitee: The entity that is being invited.
    720         @type invitee: L{jid.JID}
     719        @type invitee: L{JID<twisted.words.protocols.jabber.jid.JID>}
    721720
    722721        @param reason: The reason for the invite.
    … …  
    734733        @param room: The room jabber/xmpp entity id for the requested
    735734            registration form.
    736         @type room: L{jid.JID}
     735        @type room: L{JID<twisted.words.protocols.jabber.jid.JID>}
    737736        """
    738737        def cb(response):
    … …  
    751750
    752751        @param roomJID: The bare JID of the room.
    753         @type roomJID: L{jid.JID}
     752        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    754753
    755754        @param options: A mapping of field names to values, or C{None} to
    … …  
    768767
    769768        @param roomJID: The room jabber/xmpp entity id.
    770         @type roomJID: L{jid.JID}
     769        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    771770        """
    772771        message = VoiceRequest(recipient=roomJID)
    … …  
    781780
    782781        @param roomJID: The room jabber/xmpp entity id.
    783         @type roomJID: L{jid.JID}
     782        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    784783
    785784        @param messages: The history to send to the room as an ordered list of
    … …  
    788787                         L{domish.Element}, and C{'timestamp'} with the
    789788                         timestamp.
    790         @type messages: L{list} of L{domish.Element}
     789        @type messages: C{list} of L{domish.Element}
    791790        """
    792791
    … …  
    817816
    818817        @param roomJID: The bare JID of the room.
    819         @type roomJID: L{jid.JID}
     818        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    820819
    821820        @return: A deferred that fires with the room's configuration form as
    … …  
    838837
    839838        @param roomJID: The room to configure.
    840         @type roomJID: L{jid.JID}
     839        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    841840
    842841        @param options: A mapping of field names to values, or C{None} to
    … …  
    885884
    886885        @param roomJID: The bare JID of the room.
    887         @type roomJID: L{jid.JID}
     886        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    888887        """
    889888        return self._getAffiliationList(roomJID, 'member')
    … …  
    895894
    896895        @param roomJID: The bare JID of the room.
    897         @type roomJID: L{jid.JID}
     896        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    898897        """
    899898        return self._getAffiliationList(roomJID, 'admin')
    … …  
    905904
    906905        @param roomJID: The bare JID of the room.
    907         @type roomJID: L{jid.JID}
     906        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    908907        """
    909908        return self._getAffiliationList(roomJID, 'outcast')
    … …  
    915914
    916915        @param roomJID: The bare JID of the room.
    917         @type roomJID: L{jid.JID}
     916        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    918917        """
    919918        return self._getAffiliationList(roomJID, 'owner')
    … …  
    925924
    926925        @param roomJID: The bare JID of the room.
    927         @type roomJID: L{jid.JID}
     926        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    928927        """
    929928        d = self._getRoleList(roomJID, 'moderator')
    … …  
    961960
    962961        @param roomJID: The bare JID of the room.
    963         @type roomJID: L{jid.JID}
     962        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    964963
    965964        @param entities: The list of entities to change for a room.
    966         @type entities: L{list} of L{jid.JID}
     965        @type entities: C{list} of
     966            L{JID<twisted.words.protocols.jabber.jid.JID>}
    967967
    968968        @param affiliation: The affilation to the entities will acquire.
    … …  
    970970
    971971        @param sender: The entity sending the request.
    972         @type sender: L{jid.JID}
     972        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    973973
    974974        """
    … …  
    986986
    987987        @param roomJID: The bare JID of the room.
    988         @type roomJID: L{jid.JID}
     988        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    989989
    990990        @param nick: The nick name for the user in this room.
    … …  
    995995
    996996        @param sender: The entity sending the request.
    997         @type sender: L{jid.JID}
     997        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    998998        """
    999999        return self._setRole(roomJID, nick=nick,
    … …  
    10091009
    10101010        @param roomJID: The bare JID of the room.
    1011         @type roomJID: L{jid.JID}
     1011        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10121012
    10131013        @param nick: The nick name for the user in this room.
    … …  
    10181018
    10191019        @param sender: The entity sending the request.
    1020         @type sender: L{jid.JID}
     1020        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10211021        """
    10221022        return self._setRole(roomJID, nick=nick, role='visitor',
    … …  
    10291029
    10301030        @param roomJID: The bare JID of the room.
    1031         @type roomJID: L{jid.JID}
     1031        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10321032
    10331033        @param nick: The nick name for the user in this room.
    … …  
    10381038
    10391039        @param sender: The entity sending the request.
    1040         @type sender: L{jid.JID}
     1040        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10411041        """
    10421042        return self._setRole(roomJID, nick=nick, role='moderator',
    … …  
    10491049
    10501050        @param roomJID: The bare JID of the room.
    1051         @type roomJID: L{jid.JID}
     1051        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10521052
    10531053        @param entity: The bare JID of the entity to be banned.
    1054         @type entity: L{jid.JID}
     1054        @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10551055
    10561056        @param reason: The reason for banning the entity.
    … …  
    10581058
    10591059        @param sender: The entity sending the request.
    1060         @type sender: L{jid.JID}
     1060        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10611061        """
    10621062        return self._setAffiliation(roomJID, entity, 'outcast',
    … …  
    10691069
    10701070        @param roomJID: The bare JID of the room.
    1071         @type roomJID: L{jid.JID}
     1071        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10721072
    10731073        @param nick: The occupant to be banned.
    … …  
    10781078
    10791079        @param sender: The entity sending the request.
    1080         @type sender: L{jid.JID}
     1080        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10811081        """
    10821082        return self._setRole(roomJID, nick, 'none',
    … …  
    10891089
    10901090        @param roomJID: The JID of the room.
    1091         @type roomJID: L{jid.JID}
     1091        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10921092
    10931093        @param reason: The reason for the destruction of the room.
    … …  
    10951095
    10961096        @param alternate: The JID of the room suggested as an alternate venue.
    1097         @type alternate: L{jid.JID}
     1097        @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
    10981098
    10991099        """
    … …  
    11291129
    11301130    @ivar roomJID: The Room JID of the MUC room.
    1131     @type roomJID: L{JID}
     1131    @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    11321132
    11331133    @ivar nick: The nick name for the client in this room.
    … …  
    11361136    @ivar occupantJID: The JID of the occupant in the room. Generated from
    11371137        roomJID and nick.
    1138     @type occupantJID: L{jid.JID}
     1138    @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    11391139
    11401140    @ivar locked: Flag signalling a locked room. A locked room first needs
    … …  
    12081208    Multi-User Chat client protocol.
    12091209
    1210     This is a subclass of L{XMPPHandler} and implements L{IMUCCLient}.
     1210    This is a subclass of L{XMPPHandler} and implements L{IMUCClient}.
    12111211
    12121212    @ivar _rooms: Collection of occupied rooms, keyed by the bare JID of the
    … …  
    12441244        the L{Room} instance associated with it.
    12451245
    1246         @type occupantJID: L{jid.JID}
     1246        @type occupantJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    12471247        """
    12481248        return self._rooms.get(roomJID)
    … …  
    14371437
    14381438        @param roomJID: The JID of the room the entity is joining.
    1439         @type roomJID: L{jid.JID}
     1439        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    14401440
    14411441        @param nick: The nick name for the entitity joining the room.
    … …  
    14811481
    14821482        @param roomJID: The JID of the room, i.e. without a resource.
    1483         @type roomJID: L{jid.JID}
     1483        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    14841484
    14851485        @param nick: The new nick name within the room.
    … …  
    15051505
    15061506        @param roomJID: The Room JID of the room to leave.
    1507         @type roomJID: L{jid.JID}
     1507        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15081508        """
    15091509        def cb(presence):
    … …  
    15221522
    15231523        @param roomJID: The Room JID of the room.
    1524         @type roomJID: L{jid.JID}
     1524        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15251525
    15261526        @param show: The availability of the entity. Common values are xa,
    … …  
    15421542
    15431543        @param roomJID: The JID of the room.
    1544         @type roomJID: L{jid.JID}
     1544        @type roomJID: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15451545
    15461546        @param reason: The reason for the destruction of the room.
    … …  
    15481548
    15491549        @param alternate: The JID of the room suggested as an alternate venue.
    1550         @type alternate: L{jid.JID}
     1550        @type alternate: L{JID<twisted.words.protocols.jabber.jid.JID>}
    15511551
    15521552        """

  • wokkel/ping.py

    r165 r166  
    3434
    3535        @param entity: Entity to be pinged.
    36         @type entity: L{jid.JID}
     36        @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
    3737
    3838        @return: A deferred that fires upon receiving a response.
    39         @rtype: L{defer.Deferred}
     39        @rtype: L{Deferred<twisted.internet.defer.Deferred>}
    4040
    4141        @param sender: Optional sender address.
    42         @type sender: L{jid.JID}
     42        @type sender: L{JID<twisted.words.protocols.jabber.jid.JID>}
    4343        """
    4444        def cb(response):

  • wokkel/pubsub.py

    r165 r166  
    169169        """
    170170        @param id: optional item identifier
    171         @type id: L{unicode}
     171        @type id: C{unicode}
    172172        @param payload: optional item payload. Either as a domish element, or
    173173                        as serialized XML.
    174         @type payload: object providing L{domish.IElement} or L{unicode}.
     174        @type payload: object providing L{domish.IElement} or C{unicode}.
    175175        """
    176176
    … …  
    194194    C{None}.
    195195
    196     @ivar verb: The type of publish-subscribe request. See L{_requestVerbMap}.
     196    @ivar verb: The type of publish-subscribe request. See C{_requestVerbMap}.
    197197    @type verb: C{str}.
    198198
    199199    @ivar affiliations: Affiliations to be modified.
    200200    @type affiliations: C{set}
     201
    201202    @ivar items: The items to be published, as L{domish.Element}s.
    202203    @type items: C{list}
     204
    203205    @ivar itemIdentifiers: Identifiers of the items to be retrieved or
    204206                           retracted.
    205207    @type itemIdentifiers: C{set}
     208
    206209    @ivar maxItems: Maximum number of items to retrieve.
    207210    @type maxItems: C{int}.
     211
    208212    @ivar nodeIdentifier: Identifier of the node the request is about.
    209213    @type nodeIdentifier: C{unicode}
     214
    210215    @ivar nodeType: The type of node that should be created, or for which the
    211216                    configuration is retrieved. C{'leaf'} or C{'collection'}.
    212217    @type nodeType: C{str}
     218
    213219    @ivar options: Configurations options for nodes, subscriptions and publish
    214220                   requests.
    215221    @type options: L{data_form.Form}
     222
    216223    @ivar subscriber: The subscribing entity.
    217     @type subscriber: L{JID}
     224    @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
     225
    218226    @ivar subscriptionIdentifier: Identifier for a specific subscription.
    219227    @type subscriptionIdentifier: C{unicode}
     228
    220229    @ivar subscriptions: Subscriptions to be modified, as a set of
    221                          L{Subscription}.
     230        L{Subscription}.
    222231    @type subscriptions: C{set}
     232
    223233    @ivar affiliations: Affiliations to be modified, as a dictionary of entity
    224                         (L{JID} to affiliation (C{unicode}).
     234        (L{JID<twisted.words.protocols.jabber.jid.JID>} to affiliation
     235        (C{unicode}).
    225236    @type affiliations: C{dict}
    226237    """
    … …  
    599610
    600611        @param xs: The XML stream to send the request on.
    601         @type xs: L{xmlstream.XmlStream}
     612        @type xs: L{twisted.words.protocols.jabber.xmlstream.XmlStream}
    602613        @rtype: L{defer.Deferred}.
    603614        """
    … …  
    637648    @type nodeIdentifier: C{unicode}
    638649    @param headers: SHIM headers, see L{wokkel.shim.extractHeaders}.
    639     @type headers: L{dict}
     650    @type headers: C{dict}
    640651    """
    641652
    … …  
    758769
    759770        @param service: The publish subscribe service to create the node at.
    760         @type service: L{JID}
     771        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    761772        @param nodeIdentifier: Optional suggestion for the id of the node.
    762773        @type nodeIdentifier: C{unicode}
    … …  
    793804
    794805        @param service: The publish subscribe service to delete the node from.
    795         @type service: L{JID}
     806        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    796807        @param nodeIdentifier: The identifier of the node.
    797808        @type nodeIdentifier: C{unicode}
    … …  
    810821
    811822        @param service: The publish subscribe service that keeps the node.
    812         @type service: L{JID}
     823        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    813824
    814825        @param nodeIdentifier: The identifier of the node.
    … …  
    817828        @param subscriber: The entity to subscribe to the node. This entity
    818829            will get notifications of new published items.
    819         @type subscriber: L{JID}
     830        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    820831
    821832        @param options: Subscription options.
    … …  
    862873
    863874        @param service: The publish subscribe service that keeps the node.
    864         @type service: L{JID}
     875        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    865876
    866877        @param nodeIdentifier: The identifier of the node.
    … …  
    868879
    869880        @param subscriber: The entity to unsubscribe from the node.
    870         @type subscriber: L{JID}
     881        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    871882
    872883        @param subscriptionIdentifier: Optional subscription identifier.
    … …  
    887898
    888899        @param service: The publish subscribe service that keeps the node.
    889         @type service: L{JID}
     900        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    890901        @param nodeIdentifier: The identifier of the node.
    891902        @type nodeIdentifier: C{unicode}
    … …  
    907918
    908919        @param service: The publish subscribe service that keeps the node.
    909         @type service: L{JID}
     920        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    910921
    911922        @param nodeIdentifier: The identifier of the node.
    … …  
    946957
    947958        @param service: The publish subscribe service that keeps the node.
    948         @type service: L{JID}
     959        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    949960
    950961        @param nodeIdentifier: The identifier of the node.
    … …  
    952963
    953964        @param subscriber: The entity subscribed to the node.
    954         @type subscriber: L{JID}
     965        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    955966
    956967        @param subscriptionIdentifier: Optional subscription identifier.
    … …  
    983994
    984995        @param service: The publish subscribe service that keeps the node.
    985         @type service: L{JID}
     996        @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
    986997
    987998        @param nodeIdentifier: The identifier of the node.
    … …  
    9891000
    9901001        @param subscriber: The entity subscribed to the node.
    991         @type subscriber: L{JID}
     1002        @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
    9921003
    9931004        @param options: Subscription options.
    … …  
    10221033    subscriptions, and sending out notifications.
    10231034
    1024     Methods from the L{IPubSubService} interface that are called as
    1025     a result of an XMPP request may raise exceptions. Alternatively the
    1026     deferred returned by these methods may have their errback called. These are
    1027     handled as follows:
     1035    Methods from the L{IPubSubService} interface that are called as a result
     1036    of an XMPP request may raise exceptions. Alternatively the deferred
     1037    returned by these methods may have their errback called. These are handled
     1038    as follows:
    10281039
    10291040     - If the exception is an instance of L{error.StanzaError}, an error

  • wokkel/subprotocols.py

    r165 r166  
    131131    @type xmlstream: L{XmlStream}
    132132    @ivar logTraffic: if true, log all traffic.
    133     @type logTraffic: L{bool}
     133    @type logTraffic: C{bool}
    134134    @ivar _initialized: Whether the stream represented by L{xmlstream} has
    135135                        been initialized. This is used when caching outgoing
    … …  
    320320
    321321        A request is an IQ L{generic.Stanza} of type C{'get'} or C{'set'}. It
    322         will have its C{toElement} called to render to a L{domish.Element}
    323         which is then sent out over the current stream. If there is no such
    324         stream (yet), it is queued and sent whenever a connection is
    325         established and initialized, just like L{send}.
     322        will have its C{toElement} called to render to a
     323        L{Element<twisted.words.xish.domish.Element>} which is then sent out
     324        over the current stream. If there is no such stream (yet), it is queued
     325        and sent whenever a connection is established and initialized, just
     326        like L{send}.
    326327
    327328        If the request doesn't have an identifier, it will be assigned a fresh
    328329        one, so the response can be tracked.
    329330
    330         The deferred that is returned will fire with the L{domish.Element}
    331         representation of the response if it is a result iq. If the response
    332         is an error iq, a corresponding L{error.StanzaError} will be errbacked.
     331        The deferred that is returned will fire with the
     332        L{Element<twisted.words.xish.domish.Element>} representation of the
     333        response if it is a result iq. If the response is an error iq, a
     334        corresponding L{error.StanzaError} will be errbacked.
    333335
    334336        If the connection is closed before a response was received, the deferred
    … …  
    336338
    337339        A request may also have a timeout, either by setting a default timeout
    338         in L{StreamManager.timeout} or on the C{timeout} attribute of the
    339         request.
     340        in L{StreamManager}'s C{timeout} attribute or on the C{timeout}
     341        attribute of the request.
    340342
    341343        @param request: The IQ request.
    … …  
    419421    @cvar iqHandlers: Mapping from XPath queries (as a string) to the method
    420422                      name that will handle requests that match the query.
    421     @type iqHandlers: L{dict}
     423    @type iqHandlers: C{dict}
    422424    """
    423425

  • wokkel/xmppim.py

    r165 r166  
    363363    subscription and their replies.
    364364
    365     Based on L{BasePresence} and {Stanza}, it just uses the L{stanzaType}
     365    Based on L{BasePresence} and {Stanza}, it just uses the C{stanzaType}
    366366    attribute to represent the type of subscription presence. This can be
    367367    one of C{'subscribe'}, C{'unsubscribe'}, C{'subscribed'} and
Note: See TracChangeset for help on using the changeset viewer.