~ubuntu-branches/ubuntu/maverick/telepathy-glib/maverick

« back to all changes in this revision

Viewing changes to spec/Connection_Interface_Forwarding.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2010-06-14 17:42:08 UTC
  • mfrom: (1.6.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20100614174208-7b6teypo8jnx5uux
Tags: 0.11.7-1
* New upstream version
  - requires gobject-introspection 0.6.13
  - new ABI, API

Show diffs side-by-side

added added

removed removed

Lines of Context:
105
105
      </tp:enumvalue>
106
106
 
107
107
      <tp:enumvalue value="1" suffix="Busy">
108
 
        <tp:docstring>
 
108
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
109
109
          <p>The incoming channel should be forwarded if a busy signal is
110
110
            detected.  What defines "Busy" is CM-specific (perhaps a single
111
111
            resource is already in use, or a user's status is set to Busy
112
112
            <tp:type>Connection_Presence_Type</tp:type>).</p>
 
113
 
113
114
          <p>If initial timeout is specified for Busy condition and call
114
115
            waiting is not supported by the service, the timeout will be
115
116
            ignored.</p>
147
148
      </tp:docstring>
148
149
 
149
150
      <tp:member type="u" name="Timeout">
150
 
        <tp:docstring>
 
151
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
151
152
          <p>The length of time (in seconds) to wait the contact to respond
152
153
            to the forwarded channel.  This MAY be ignored by the CM if it
153
154
            isn't supported by the underlying network/protocol for the
154
155
            specific status of the remote contact (for example, a GSM call
155
156
            that is forwarded may return Not_Reachable immediately without
156
157
            waiting for the timeout value to expire).</p>
 
158
 
157
159
          <p>A value of 0 means the condition can match immediately. A
158
160
            value of MAX_UINT32 means that the CM's default should be
159
161
            used.</p>
208
210
    <property name="SupportedForwardingConditions" type="a{uu}" access="read"
209
211
      tp:type="Supported_Forwarding_Conditions_Map"
210
212
      tp:name-for-bindings="Supported_Forwarding_Conditions">
211
 
      <tp:docstring>
212
 
        <p>
213
 
          A map of forwarding conditions supported on this connection to
 
213
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 
214
        <p>A map of forwarding conditions supported on this connection to
214
215
          maximum number of <tp:type>Forwarding_Rule_Entry</tp:type>
215
 
          supported for the specific condition.
216
 
          <tp:rationale>
217
 
            When forwarding is done by the provider, different providers
 
216
          supported for the specific condition.</p>
 
217
 
 
218
        <tp:rationale>
 
219
          <p>When forwarding is done by the provider, different providers
218
220
            might support different chain sizes, or provider and local
219
 
            implementation chain sizes might differ.
220
 
          </tp:rationale>
221
 
        </p>
 
221
            implementation chain sizes might differ.</p>
 
222
        </tp:rationale>
222
223
      </tp:docstring>
223
224
    </property>
224
225
 
225
226
    <property name="ForwardingRules" type="a{u(ua(uu))}" access="read"
226
227
      tp:type="Forwarding_Rule_Map" tp:name-for-bindings="Forwarding_Rules">
227
 
      <tp:docstring>
 
228
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
228
229
        <p>The current forwarding rules that are enabled for this connection.
229
230
          Forwarding rules each contain an array of type
230
231
          <tp:type>Forwarding_Rule_Entry</tp:type>.</p>
269
270
      </tp:docstring>
270
271
 
271
272
      <arg direction="in" name="Condition" type="u" tp:type="Forwarding_Condition">
272
 
        <tp:docstring>
 
273
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
273
274
          <p>The forwarding rule to override.  Note that this SHOULD not affect
274
275
            other rules; setting a rule that overrides others (such as
275
276
            Forwarding_Rule_Unconditional) will not modify other rules.  This