Differences between revisions 1 and 206 (spanning 205 versions)
Revision 1 as of 2021-250 01:25:18
Size: 3053
Editor: Singpolyma
Comment: Describe gateway JID resolution and UX considerations
Revision 206 as of 2024-039 10:15:17
Size: 893
Editor: 31
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#format wiki 🚴‍♂️ Find Your Perfect Ride with "Pedals and Paths"!
Line 3: Line 3:
This is a sketch of UX and protocol considerations for a client which wishes to help users use gateways. Hey ,
Line 5: Line 5:
In every place where the UI would ask for a Jabber ID (most notably contact add, but possibly also invite to chatroom, create chatroom from 1:1 conversation, start voice/video call to non-contact, search view where a Jabber ID can be used, etc) it should scan the user's roster for JIDs which have `disco#info > identity[category=gateway]` and show some way of choosing to enter an identifier for that gateway instead of a Jabber ID. The simplest example might be a drop-down with `disco#info > identity[type]` and optional disambiguating `disco#info > idenity[name]` such as "sms (Cheogram)". Are you ready to embark on the exciting journey of finding your ideal bicycle in 2024?
Line 7: Line 7:
If a user has unambiguously selected a gateway, use https://xmpp.org/extensions/xep-0100.html#addressing-iqgateway to get a prompt: 🌟 Look no further than "Pedals and Paths" – the ultimate guide for those seeking the perfect ride without the guesswork.
Line 9: Line 9:
{{{
<iq type='get' to='gateway.tld' id='gate1'>
  <query xmlns='jabber:iq:gateway'/>
</iq>
Whether you're a newbie or unsure where to start, our book is your roadmap to discovering the world of bicycles.
Explore road bikes, hybrids, cruisers, and more, making informed decisions that match your unique preferences.
Line 14: Line 12:
<iq type='result' from='gateway.tld' id='gate1'>
  <query xmlns='jabber:iq:gateway'>
    <desc>
      Please enter the Whatever of the
      person you would like to contact.
    </desc>
    <prompt>Whatever</prompt>
  </query>
</iq>
}}}
Let "Pedals and Paths" be your compass in the world of cycling.
Line 25: Line 14:
This text may then be used as part of the UX as makes sense to help the user feel comfortable. Getting a success here and not an error also means that `jabber:iq:gateway` can be used in the next step. Shop this book on Amazon US @ https://amzn.to/3UwfCy4
Line 27: Line 16:
NOTE: it is also acceptable (and in some UX may be preferred or even necessary) to pre-emptively ask all gateways for the prompt, instead of only once one is selected. Shop this book on Amazon UK @ https://www.amazon.co.uk/dp/B0C6HZD9GW
Line 29: Line 18:
If an identifier is (or might be, depending on UX) one for a particular gateway, use the following procedure to map it to a Jabber ID and then perform the in-context relevant action on that Jabber ID as though it had been entered directly: Shop This Book On Amazon IT @ https://www.amazon.it/dp/B0C6HZD9GW
Line 31: Line 20:
 1. If a prompt was got for `jabber:iq:gateway` above then use that protocol to finish resolution:
  {{{
<iq type='set' to='gateway.tld' id='gate2'>
  <query xmlns='jabber:iq:gateway'>
      <prompt>(555) 123-4567</prompt>
  </query>
</iq>
Happy exploring and happy riding!
Line 39: Line 22:
<iq type='result' from='gateway.tld' id='gate2'>
  <query xmlns='jabber:iq:gateway'>
    <jid>+15551234567@gateway.tld</jid>
  </query>
</iq>
}}}
 2. If an error is received in response to `jabber:iq:gateway` protocol, print the error message to the user and allow them to try again. This allows the gateway to provide useful feedback about format errors to the user.
 3. If an error was received in response to fetching the `jabber:iq:gateway` prompt, then the gateway does not support this protocol. Look for a `disco#info > feature[var="jid\20escaping"]` and if found construct a JID using XEP-0106 escaping on the user input concatenated with `@gateway.tld`
 4. If `jabber:iq:gateway` and `jid\20escaping` are both unsupported, replace any `@` in the user input with `%` and concatenate `@gateway.tld`
Best of Ridding,
Line 49: Line 24:
NOTE: If the result of this procedure is a string that is not a valid Jabber ID, it should be rejected just as if a user manually keyed in an invalid Jabber ID. Pedals and Paths team,
----
CategoryHomepage

🚴‍♂️ Find Your Perfect Ride with "Pedals and Paths"!

Hey ,

Are you ready to embark on the exciting journey of finding your ideal bicycle in 2024?

🌟 Look no further than "Pedals and Paths" – the ultimate guide for those seeking the perfect ride without the guesswork.

Whether you're a newbie or unsure where to start, our book is your roadmap to discovering the world of bicycles. Explore road bikes, hybrids, cruisers, and more, making informed decisions that match your unique preferences.

Let "Pedals and Paths" be your compass in the world of cycling.

Shop this book on Amazon US @ https://amzn.to/3UwfCy4

Shop this book on Amazon UK @ https://www.amazon.co.uk/dp/B0C6HZD9GW

Shop This Book On Amazon IT @ https://www.amazon.it/dp/B0C6HZD9GW

Happy exploring and happy riding!

Best of Ridding,

Pedals and Paths team,


CategoryHomepage

GatewayContactUX (last edited 2024-130 12:13:55 by 196)