Warning: Can't synchronize with repository "(default)" (No changeset 96d22ec3fa3ef6de3ea8dc0d7d398adc9aa071cf in the repository). Look in the Trac log for more information.

Changeset 41a0c40 in Dbus API specifications for html/org.freesmartphone.Usage.html


Ignore:
Timestamp:
11/14/08 01:41:20 (5 years ago)
Author:
Michael 'Mickey' Lauer <mickey@…>
Branches:
820cacfd324a623a04b3e22f319e9220819d6ec4, 0.11, 675acad2f1510526a93c9777d03664766c823aab, morphis/pending, morphis/sms-rework
Children:
8c2342b
Parents:
39476e4
git-author:
Michael 'Mickey' Lauer <mickey@…> (11/14/08 01:41:20)
git-committer:
Michael 'Mickey' Lauer <mickey@…> (11/14/08 01:41:20)
Message:

regenerate everything as per tools update

File:
1 edited

Legend:

Unmodified
Added
Removed

  • html/org.freesmartphone.Usage.html

    r8910efc r41a0c40  
    3838</ul> 
    3939<h1>Methods</h1><h3><a name="ListResources">ListResources</a> ( ) &rarr; as</h3> 
    40 <p><i>Description:</i> List available resources.</p><h4>Returns</h4><i>as: resources</i><p>An array of resource names.</p> 
     40<p><i>Description:</i> List available resources. </p><h4>Returns</h4><i>as: resources</i><p>An array of resource names.</p> 
    4141<h3><a name="GetResourcePolicy">GetResourcePolicy</a> ( s ) &rarr; s</h3> 
    42 <p><i>Description:</i> Get the current resource policy for a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>s: policy</i><p>The resource policy. Expected values are:  <ul>  <li>"disabled" - using this resource is currently not allowed,</li>  <li>"auto" - the resource is enabled as long as it is used by at least one client,</li>  <li>"enabled" - the resource is enabled even without a client.</li>  </ul></p> 
     42<p><i>Description:</i> Get the current resource policy for a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>s: policy</i><p>The resource policy. Expected values are:  <ul>  <li>"disabled" - using this resource is currently not allowed,</li>  <li>"auto" - the resource is enabled as long as it is used by at least one client,</li>  <li>"enabled" - the resource is enabled even without a client.</li>  </ul></p> 
    4343<h3><a name="SetResourcePolicy">SetResourcePolicy</a> ( ss )</h3> 
    44 <p><i>Description:</i> Set a new resource policy for a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><i>s: policy</i><p>The new resource policy. See 'GetResourcePolicy' for valid values.</p> 
     44<p><i>Description:</i> Set a new resource policy for a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><i>s: policy</i><p>The new resource policy. See 'GetResourcePolicy' for valid values.</p> 
    4545<h3><a name="GetResourceState">GetResourceState</a> ( s ) &rarr; b</h3> 
    46 <p><i>Description:</i> Get the current state for a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p> 
     46<p><i>Description:</i> Get the current state for a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p> 
    4747<h3><a name="GetResourceUsers">GetResourceUsers</a> ( s ) &rarr; as</h3> 
    48 <p><i>Description:</i> Get the users which currently use a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>as: users</i><p>An array of bus names using the resource.</p> 
     48<p><i>Description:</i> Get the users which currently use a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>as: users</i><p>An array of bus names using the resource.</p> 
    4949<h3><a name="RequestResource">RequestResource</a> ( s )</h3> 
    50 <p><i>Description:</i> Occupy a given resource. An error is returned if the resource was not occupied sucessfully.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
     50<p><i>Description:</i> Occupy a given resource. An error is returned if the resource was not occupied sucessfully. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
    5151<h3><a name="ReleaseResource">ReleaseResource</a> ( s )</h3> 
    52 <p><i>Description:</i> Release a given resource.</p><p><div class="rationale"><p>Resources in use get autoreleased when a client leaves the bus.</p></div></p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
    53 <h3><a name="Suspend">Suspend</a> ( )</h3><p><i>Description:</i> Triggers a suspend on all managed resources and puts the device into suspend mode.  When the device comes back from suspend, all resources are resumed.</p><p><div class="rationale"><p>Resources need to implement org.freesmartphone.Resource.Suspend and  org.freesmartphone.Resource.Resume if they have anything to do  on suspend and resume.</p></div></p> 
    54 <h1>Signals</h1><h3><h3><a name="ResourceAvailable">ResourceAvailable</a> ( sb )</h3><p><i>Description:</i> Sent whenever a resource is added or removed.</p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: availability</i><p>The resource availability. True if the resource is currently available.</p></h3> 
    55 <h3><h3><a name="ResourceChanged">ResourceChanged</a> ( sba{sv} )</h3><p><i>Description:</i> Sent whenever a resource status changes.</p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p><i>a{sv}: attributes</i><p>The new status of the resource. Expected values are:  <ul>  <li>"policy": The current resource policy</li>  <li>"refcount": The count of clients that have requested the resource</li>  </ul>  Further information can be part of the properties.</p></h3> 
    56 <h1>Errors</h1><h3><a name="PolicyUnknown">PolicyUnknown</a></h3><p><i>Description:</i> Raised, if the requested policy is unknown.</p> 
    57 <h3><a name="PolicyDisabled">PolicyDisabled</a></h3><p><i>Description:</i> Raised, if the requested resource is set to policy "disabled".</p> 
    58 <h3><a name="ResourceUnknown">ResourceUnknown</a></h3><p><i>Description:</i> Raised, if the requested resource is unknown.</p> 
    59 <h3><a name="ResourceExists">ResourceExists</a></h3><p><i>Description:</i> Raised, if a (new) resource has already been registered.</p> 
    60 <h3><a name="ResourceInUse">ResourceInUse</a></h3><p><i>Description:</i> Raised, if the to-be-disabled (by policy) resource is still in use.</p> 
    61 <h3><a name="UserExists">UserExists</a></h3><p><i>Description:</i> Raised, if the requested resource has already been requested by the same user.</p> 
    62 <h3><a name="UserUnknown">UserUnknown</a></h3><p><i>Description:</i> Raised, if the to-be-released resource has never been requested by the user.</p> 
     52<p><i>Description:</i> Release a given resource. </p><p><div class="rationale"><p>Resources in use get autoreleased when a client leaves the bus.</p></div></p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
     53<h3><a name="Suspend">Suspend</a> ( )</h3><p><i>Description:</i> Triggers a suspend on all managed resources and puts the device into suspend mode.  When the device comes back from suspend, all resources are resumed. </p><p><div class="rationale"><p>Resources need to implement org.freesmartphone.Resource.Suspend and  org.freesmartphone.Resource.Resume if they have anything to do  on suspend and resume.</p></div></p> 
     54<h1>Signals</h1><h3><h3><a name="ResourceAvailable">ResourceAvailable</a> ( sb )</h3><p><i>Description:</i> Sent whenever a resource is added or removed. </p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: availability</i><p>The resource availability. True if the resource is currently available.</p></h3> 
     55<h3><h3><a name="ResourceChanged">ResourceChanged</a> ( sba{sv} )</h3><p><i>Description:</i> Sent whenever a resource status changes. </p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p><i>a{sv}: attributes</i><p>The new status of the resource. Expected values are:  <ul>  <li>"policy": The current resource policy</li>  <li>"refcount": The count of clients that have requested the resource</li>  </ul>  Further information can be part of the properties.</p></h3> 
     56<h1>Errors</h1><h3><a name="PolicyUnknown">PolicyUnknown</a></h3><p><i>Description:</i> Raised, if the requested policy is unknown. </p> 
     57<h3><a name="PolicyDisabled">PolicyDisabled</a></h3><p><i>Description:</i> Raised, if the requested resource is set to policy "disabled". </p> 
     58<h3><a name="ResourceUnknown">ResourceUnknown</a></h3><p><i>Description:</i> Raised, if the requested resource is unknown. </p> 
     59<h3><a name="ResourceExists">ResourceExists</a></h3><p><i>Description:</i> Raised, if a (new) resource has already been registered. </p> 
     60<h3><a name="ResourceInUse">ResourceInUse</a></h3><p><i>Description:</i> Raised, if the to-be-disabled (by policy) resource is still in use. </p> 
     61<h3><a name="UserExists">UserExists</a></h3><p><i>Description:</i> Raised, if the requested resource has already been requested by the same user. </p> 
     62<h3><a name="UserUnknown">UserUnknown</a></h3><p><i>Description:</i> Raised, if the to-be-released resource has never been requested by the user. </p> 
    6363 
    6464    <hr/> 
Note: See TracChangeset for help on using the changeset viewer.