← Back to branch summary

~ubuntu-branches/ubuntu/wily/telepathy-glib/wily

« back to all changes in this revision

Viewing changes to spec/Connection_Interface_Aliasing.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2009-03-24 22:06:52 UTC
  • mfrom: (1.3.1 upstream) (17.1.10 sid)
  • Revision ID: james.westby@ubuntu.com-20090324220652-c8dvom0nsqomp23d
Tags: 0.7.28-1
* New upstream version (ABI, API added)
* Put the -dbg package in section debug, as per recent archive changes
* Remove obsolete Conflicts/Replaces with libtelepathy-glib-static-dev, which
  was never in a stable release (and probably never in Debian at all)

Show diffs side-by-side

added added

removed removed

Lines of Context:
spec/Connection_Interface_Aliasing.xml
29
29
    </tp:mapping>
30
30
 
31
31
    <tp:struct name="Alias_Pair" array-name="Alias_Pair_List">
32
 
      <tp:docstring>A pair (contact handle, alias) as seen in the AliasesChanged
33
 
        signal.</tp:docstring>
 
32
      <tp:docstring>
 
33
        A pair (contact handle, alias) as seen in the
 
34
        <tp:member-ref>AliasesChanged</tp:member-ref> signal.
 
35
      </tp:docstring>
34
36
      <tp:member type="u" tp:type="Contact_Handle" name="Handle"/>
35
37
      <tp:member type="s" name="Alias"/>
36
38
    </tp:struct>
37
39
 
38
 
    <signal name="AliasesChanged">
39
 
      <arg name="aliases" type="a(us)" tp:type="Alias_Pair[]">
 
40
    <signal name="AliasesChanged" tp:name-for-bindings="Aliases_Changed">
 
41
      <arg name="Aliases" type="a(us)" tp:type="Alias_Pair[]">
40
42
        <!-- FIXME: if we break API, this could be an Alias_Map, a{us} -->
41
43
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
42
44
          An array containing structs of:
68
70
        </tp:docstring>
69
71
      </tp:flag>
70
72
    </tp:flags>
71
 
    <method name="GetAliasFlags">
72
 
      <arg direction="out" type="u" tp:type="Connection_Alias_Flags">
 
73
    <method name="GetAliasFlags" tp:name-for-bindings="Get_Alias_Flags">
 
74
      <arg direction="out" type="u" tp:type="Connection_Alias_Flags"
 
75
        name="Alias_Flags">
73
76
        <tp:docstring>
74
77
          An integer with a bitwise OR of flags from ConnectionAliasFlags
75
78
        </tp:docstring>
82
85
        <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
83
86
      </tp:possible-errors>
84
87
    </method>
85
 
    <method name="RequestAliases">
86
 
      <arg direction="in" name="contacts" type="au" tp:type="Contact_Handle[]">
 
88
    <method name="RequestAliases" tp:name-for-bindings="Request_Aliases">
 
89
      <arg direction="in" name="Contacts" type="au" tp:type="Contact_Handle[]">
87
90
        <tp:docstring>
88
91
          An array of handles representing contacts
89
92
        </tp:docstring>
90
93
      </arg>
91
 
      <arg direction="out" type="as">
 
94
      <arg direction="out" type="as" name="Aliases">
92
95
        <tp:docstring>
93
96
          A list of aliases in the same order as the contact handles
94
97
        </tp:docstring>
103
106
        <tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/>
104
107
      </tp:possible-errors>
105
108
    </method>
106
 
    <method name="SetAliases">
107
 
      <arg direction="in" name="aliases" type="a{us}" tp:type="Alias_Map">
 
109
    <method name="GetAliases" tp:name-for-bindings="Get_Aliases">
 
110
      <arg direction="in" name="Contacts" type="au" tp:type="Contact_Handle[]">
 
111
        <tp:docstring>
 
112
          An array of handles representing contacts
 
113
        </tp:docstring>
 
114
      </arg>
 
115
      <arg direction="out" type="a{us}" tp:type="Alias_Map" name="Aliases">
 
116
        <tp:docstring>
 
117
          A dictionary mapping contact handles to aliases
 
118
        </tp:docstring>
 
119
      </arg>
 
120
      <tp:docstring>
 
121
        Request the value of several contacts' aliases at once. This SHOULD
 
122
        only return cached aliases, falling back on the handle name if none is
 
123
        present. Also if there was no cached alias, a request SHOULD be started
 
124
        of which the result is later signalled by
 
125
        <tp:member-ref>AliasesChanged</tp:member-ref>.
 
126
      </tp:docstring>
 
127
      <tp:possible-errors>
 
128
        <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
 
129
        <tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/>
 
130
      </tp:possible-errors>
 
131
    </method>
 
132
    <method name="SetAliases" tp:name-for-bindings="Set_Aliases">
 
133
      <arg direction="in" name="Aliases" type="a{us}" tp:type="Alias_Map">
108
134
        <tp:docstring>
109
135
          A dictionary mapping integer handles of contacts
110
136
          to strings of the new alias to set.
112
138
      </arg>
113
139
      <tp:docstring>
114
140
        Request that the alias of the given contact be changed. Success will be
115
 
        indicated by emitting an AliasesChanged signal. On connections where the
116
 
        CONNECTION_ALIAS_FLAG_USER_SET flag is not set, this method will only
117
 
        ever succeed if the contact is the user's own handle (as returned by
118
 
        GetSelfHandle on the Connection interface).
 
141
        indicated by emitting an <tp:member-ref>AliasesChanged</tp:member-ref>
 
142
        signal. On connections where the CONNECTION_ALIAS_FLAG_USER_SET flag is
 
143
        not set, this method will only ever succeed if the contact is the
 
144
        user's own handle (as returned by <tp:dbus-ref
 
145
          namespace="org.freedesktop.Telepathy">Connection.GetSelfHandle</tp:dbus-ref>).
119
146
      </tp:docstring>
120
147
      <tp:possible-errors>
121
148
        <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
132
159
    alias is changed or first discovered.</p>
133
160
 
134
161
    <p>On connections where the user is allowed to set aliases for contacts and
135
 
    store them on the server, the GetAliasFlags method will have the
136
 
    CONNECTION_ALIAS_FLAG_USER_SET flag set, and the SetAliases method
137
 
    may be called on contact handles other than the user themselves.</p>
 
162
    store them on the server, the <tp:member-ref>GetAliasFlags</tp:member-ref>
 
163
    method will have the CONNECTION_ALIAS_FLAG_USER_SET flag set, and the
 
164
    <tp:member-ref>SetAliases</tp:member-ref> method may be called on contact
 
165
    handles other than the user themselves.</p>
138
166
 
139
167
    <p>Aliases are intended to be used as the main displayed name for the
140
168
    contact, where available.</p>