Differences between revisions 97 and 359 (spanning 262 versions)
Revision 97 as of 2023-273 21:06:50
Size: 1447
Editor: 195
Comment:
Revision 359 as of 2024-248 15:42:59
Size: 3061
Comment: Revert spam
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
✨ Are you ready to embark on an epic adventure where the power of your marketing efforts is multiplied tenfold? This is a sketch of UX and protocol considerations for a client which wishes to help users use gateways.
Line 3: Line 3:
🎉 Meet **Lead Hero** – where ordinary clicks become extraordinary achievements! 🎉 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)".
Line 5: Line 5:
https://warriorplus.com/o2/a/m01175/0 If a user has unambiguously selected a gateway, use https://xmpp.org/extensions/xep-0100.html#addressing-iqgateway to get a prompt:
Line 7: Line 7:
We're thrilled to introduce you to the digital realm's latest sensation. It's not just another tool, but a game-changer in the truest sense. {{{
<iq type='get' to='gateway.tld' id='gate1'>
  <query xmlns='jabber:iq:gateway'/>
</iq>
Line 9: Line 12:
**Why is Lead Hero a game-changer for your business?** <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>
}}}
Line 11: Line 23:
🚀 **Supercharged Traffic**: With Lead Hero, get ready to experience an explosion in your traffic like never before.
🛡 **The League of Marketing Superheroes**: Join a community of elite marketers who are setting benchmarks and shattering limits daily.
💪 **1 Powerful Button**: Simplicity at its finest! With just one button, watch your results skyrocket. You don't need a tech degree to conquer the digital universe.
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.
Line 15: Line 25:
So, are you ready to rise above the rest, harness unparalleled powers, and save your business from drowning in the vast digital ocean? 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.
Line 17: Line 27:
👉 **Join Lead Hero Now** and be the hero your business deserves: https://warriorplus.com/o2/a/m01175/0 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:
Line 19: Line 29:
But that's not all! We have a special **early bird offer** for our first batch of superheroes. Sign up within the next 48 hours to unlock exclusive perks that will give you a head start in this epic journey!  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>
Line 21: Line 37:
Remember, every hero needs an origin story. Make Lead Hero yours. <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`
Line 23: Line 47:
Stay super, 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.

This is a sketch of UX and protocol considerations for a client which wishes to help users use gateways.

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)".

If a user has unambiguously selected a gateway, use https://xmpp.org/extensions/xep-0100.html#addressing-iqgateway to get a prompt:

<iq type='get' to='gateway.tld' id='gate1'>
  <query xmlns='jabber:iq:gateway'/>
</iq>

<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>

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.

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.

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:

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>

<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`

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.


CategoryHomepage

GatewayContactUX (last edited 2024-322 17:13:29 by ip157)