mirror of https://github.com/moparisthebest/xeps
IQ Relay
This commit is contained in:
Steve Kille
parent
91418da01a
commit
12550df3b6
88
xep-0403.xml
88
xep-0403.xml
|
|
@ -195,10 +195,10 @@
|
|||
|
||||
|
||||
<section1 topic='Use Cases' anchor='usecases'>
|
||||
<section2 topic='Common User Use Cases' anchor='usecases-user'>
|
||||
|
||||
|
||||
<section3 topic='Setting User Presence' anchor='usecase-user-presence'>
|
||||
|
||||
<section2 topic='Setting User Presence' anchor='usecase-user-presence'>
|
||||
<p>
|
||||
|
||||
A user joins a channel over an extended period, and participation in a channel does not generally change when user goes online or offline. The user's participation in a channel is reflected by the user's bare JID in the participant node. All messages to the channel are sent to this JID.
|
||||
|
|
@ -254,27 +254,27 @@ A user MAY share presence information with the channel, for one or more online c
|
|||
<p>
|
||||
The history of the presence node MAY be archived using MAM. The MAM archive stores the node in PubSub format, following the node specification. This enables presence history to be retrieved using PubSub.
|
||||
</p>
|
||||
</section3>
|
||||
</section2>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section3 topic="Client Coming Online and Obtaining Presence from the Local Server" anchor="usecase-obtaining-presence">
|
||||
<section2 topic="Client Coming Online and Obtaining Presence from the Local Server" anchor="usecase-obtaining-presence">
|
||||
<p>
|
||||
MIX Clients obtain presence from their local server. This is specified in &xep0405;.
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
</section3>
|
||||
</section2>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section3 topic='Going Offline' anchor='usecase-user-offline'>
|
||||
<section2 topic='Going Offline' anchor='usecase-user-offline'>
|
||||
<p>When a client goes offline, this presence update is sent by the client's server to the MIX channel. From the client perspective, this is the same as any other presence change. The MIX Channel also needs to remove the client from the participant's node.</p>
|
||||
<example caption="Client Goes Offline in the Channel"><![CDATA[
|
||||
<presence type='unavailable'
|
||||
|
|
@ -300,9 +300,9 @@ A user MAY share presence information with the channel, for one or more online c
|
|||
|
||||
|
||||
|
||||
</section3>
|
||||
</section2>
|
||||
|
||||
<section3 topic="User Leaving a Channel" anchor="usecase-presence-leave">
|
||||
<section2 topic="User Leaving a Channel" anchor="usecase-presence-leave">
|
||||
<p>
|
||||
The primary actions for a user leaving a channel are specified in &xep0369;. This section sets out additional actions for handling presence. When a user leaves the channel, all entries for the user's clients MUST be removed from the participants node. The MIX channel MUST distribute unavailable presence notifications for each client removed to all subscribers of the participants node.
|
||||
</p>
|
||||
|
|
@ -318,9 +318,79 @@ A user MAY share presence information with the channel, for one or more online c
|
|||
</mix>
|
||||
</presence>]]></example>
|
||||
|
||||
</section3>
|
||||
</section2>
|
||||
|
||||
|
||||
<section2 topic="Relaying IQ Stanzas" anchor="usecase-iq-relay">
|
||||
<p>
|
||||
MIX channels MAY relay IQ stanzas between participants. This is often useful to obtain client information where a direct request to the client would be blocked. When a client sends an IQ stanza through a MIX channel, it will set the 'from' to its own JID and set the 'to' to the encoded JID of the recipient. The MIX channel will modify the JIDs in the outgoing message, so that the 'to' is the full JID of the recipient and the 'from' is the encoded JID of the sender. This is illustrated in the vCard section below.
|
||||
</p>
|
||||
</section2>
|
||||
|
||||
|
||||
|
||||
<section2 topic="Requesting a vCard through a Channel" anchor="usecase-vcard">
|
||||
<p>A client MAY request the vCard of a channel participant through a MIX channel, for example to get an avatar. The MIX channel MAY pass this request on or MAY block it. vCard requests MAY use &xep0054; (vcard-temp) or &xep0292; (vCard4 over XMPP). The MIX channel does not process the vCard requests, but simply relays them on to real bare JID of the target. A MIX service MAY choose to relay one or both protocols. Where a MIX service relays one or both of these protocols, each protocol relayed MUST be advertised as a feature of the MIX service. In the following example, using vcard-temp, the requesting client sends a message to the encoded JID of the channel participant for which the vCard is desired.</p>
|
||||
<example caption="Client directly requests vCard through channel" ><![CDATA[
|
||||
<iq from='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
id='lx09df27'
|
||||
to='989898#coven@mix.shakespeare.example'
|
||||
type='get'>
|
||||
<vCard xmlns='vcard-temp'/>
|
||||
</iq>
|
||||
]]></example>
|
||||
<p>The MIX channel MAY pass on the vCard request or MAY reject with an error, dependent on channel policy. The MIX service will then address the vCard request to the user's server (using bare JID) using an the encoded JID of the requester in the 'from'. </p>
|
||||
<example caption="Channel passes on vCard request to the User's Server" ><![CDATA[
|
||||
<iq from='123456#coven@mix.shakespeare.example/6789'
|
||||
id='lx09df27'
|
||||
to='peter@shakespeare.example'
|
||||
type='get'>
|
||||
<vCard xmlns='vcard-temp'/>
|
||||
</iq>
|
||||
]]></example>
|
||||
<p>
|
||||
The user's server, on behalf of the user, MAY send a response or reject with an error. The user's server will send the vCard back to the channel.
|
||||
</p>
|
||||
<example caption="User's Server sends vCard Response via MIX channel" ><![CDATA[
|
||||
<iq from='peter@shakespeare.example'
|
||||
id='lx09df27'
|
||||
to='123456#coven@mix.shakespeare.example/6789'
|
||||
type='result'>
|
||||
<vCard xmlns='vcard-temp'>
|
||||
<FN>Peter Saint-Andre</FN>
|
||||
<N>
|
||||
<FAMILY>Saint-Andre</FAMILY>
|
||||
<GIVEN>Peter</GIVEN>
|
||||
<MIDDLE/>
|
||||
</N>
|
||||
<NICKNAME>stpeter</NICKNAME>
|
||||
<URL>http://www.xmpp.org/xsf/people/stpeter.shtml</URL>
|
||||
</vCard>
|
||||
<query xmlns='http://jabber.org/protocol/disco#info'>
|
||||
</iq>
|
||||
]]></example>
|
||||
<p>
|
||||
The MIX channel will then send the vCard response to the requesting client on behalf of the client sending the response.
|
||||
</p>
|
||||
<example caption="MIX Channel sends vCard responst to Client" ><![CDATA[
|
||||
<iq from='989898#coven@mix.shakespeare.example'
|
||||
id='lx09df27'
|
||||
to='hag66@shakespeare.example/UUID-c8y/1573'
|
||||
type='result'>
|
||||
<vCard xmlns='vcard-temp'>
|
||||
<FN>Peter Saint-Andre</FN>
|
||||
<N>
|
||||
<FAMILY>Saint-Andre</FAMILY>
|
||||
<GIVEN>Peter</GIVEN>
|
||||
<MIDDLE/>
|
||||
</N>
|
||||
<NICKNAME>stpeter</NICKNAME>
|
||||
<URL>http://www.xmpp.org/xsf/people/stpeter.shtml</URL>
|
||||
</vCard>
|
||||
</iq>
|
||||
]]></example>
|
||||
</section2>
|
||||
|
||||
</section1>
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue