diff options
author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2008-05-08 08:50:19 +0000 |
---|---|---|
committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2008-05-08 08:50:19 +0000 |
commit | e73e4dedeede59e86346f73bccd9c324b2417c14 (patch) | |
tree | a780f0d2c9e984fcb4a229df62b4d2cbffc9bfd7 /spec | |
parent | 81993a3ea32bfe243cecb3dd5542096f0025d39d (diff) |
Update Account API from telepathy-spec
Diffstat (limited to 'spec')
-rw-r--r-- | spec/Account.xml | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/spec/Account.xml b/spec/Account.xml index f8800739d..dc1eff71d 100644 --- a/spec/Account.xml +++ b/spec/Account.xml @@ -192,6 +192,39 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </tp:docstring> </property> + <property name="Enabled" type="b" access="readwrite"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>This property gives the users the possibility to prevent an account + from being used. This flag does not change the validity of the + account.</p> + + <p>A disabled account can never be put online.</p> + + <tp:rationale> + <p>Use cases:</p> + + <ul> + <li>user has two or more accounts capable of calling contact X, but + he doesn't want the UI to prompt him everytime about which one he + wants to use for the call. He can then disable all the equivalent + accounts but one.</li> + + <li>There is some temporary server error and the user doesn't want + to be be bother by error messages, or change the account + configuration: temporarily disabling the account is quicker.</li> + </ul> + + <p>The AccountManager SHOULD allow this property to be set on invalid + accounts, but MUST NOT attempt to put invalid accounts online + even if they become Enabled.</p> + + <tp:rationale> + <p>There doesn't seem to be any good reason not to allow this.</p> + </tp:rationale> + </tp:rationale> + </tp:docstring> + </property> + <property name="Nickname" type="as" access="readwrite"> <tp:docstring> The nickname to set on this account for display to other contacts, @@ -418,6 +451,36 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. </tp:docstring> </property> + <property name="NormalizedName" type="s" access="read"> + <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> + <p>The normalized user ID of the local user on this account (i.e. the + string returned when the InspectHandle method is called on the + result of GetSelfHandle() for an active connection).</p> + + <p>It is unspecified whether this user ID is globally unique.</p> + + <tp:rationale> + <p>As currently implemented, IRC user IDs are only unique within + the same IRCnet. On some saner protocols, the user ID includes a + DNS name which provides global uniqueness.</p> + </tp:rationale> + + <p>If this value is not known yet (which will always be the case for + accounts that have never been online), it will be an empty + string.</p> + + <p>It is possible that this value will change if the connection + manager's normalization algorithm changes, although this SHOULD + be avoided.</p> + + <tp:rationale> + <p>It's not always completely clear what normalization algorithm + should be used; for instance, in Gabble, we currently use JIDs, + but it would also have been reasonable to use xmpp URIs.</p> + </tp:rationale> + </tp:docstring> + </property> + </interface> </node> <!-- vim:set sw=2 sts=2 et ft=xml: --> |