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

Documentation fixes for pydoctor.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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
Note: See TracChangeset for help on using the changeset viewer.