~imbrandon/ubuntu-accomplishments-daemon/new-theme

« back to all changes in this revision

Viewing changes to docs/_build/html/clientref.html

Committer: Jono Bacon
Date: 2012-07-10 23:32:55 UTC
Revision ID: jono@ubuntu.com-20120710233255-l1c72tsubrnyc6ch

* More docs.

files modified:
accomplishments/daemon/dbusapi.py

docs/_build/doctrees/clientref.doctree

docs/_build/doctrees/environment.pickle

docs/_build/html/_modules/accomplishments/daemon/dbusapi.html

docs/_build/html/clientref.html

docs/_build/html/genindex.html

docs/_build/html/objects.inv

docs/_build/html/searchindex.js

Show diffs side-by-side

added added

removed removed

docs/_build/html/clientref.html

725

726

727

<tt class="descname">get_config_value</tt><big>(</big>section, item<big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.get_config_value">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.get_config_value" title="Permalink to this definition">¶</a></dt>

728

<dd>DOCS NEEDED

728

<dd>Returns the required value from the configuration file. For a list of available values

729

see <a class="reference external" href="https://wiki.ubuntu.com/Accomplishments/GetInvolved/Hacking#Configuration_Files">https://wiki.ubuntu.com/Accomplishments/GetInvolved/Hacking#Configuration_Files</a>

730

Config files are stored in Python ConfigParser format in which you look up the value by

731

section and value.

732

733

734

735

<li>section - (str) the section in the config file (usually <cite>config</cite>).</li>

736

<li>value - (str) the value you want the data for.</li>

737

</ul>

738

</dd>

739

<dt>Returns:</dt>

740

741

<li>(str) - the name of the collection.</li>

742

</ul>

743

</dd>

744

<dt>Example:</dt>

745

<dd><div class="first last highlight-python"><div class="highlight"><pre>>>> obj.get_collection_authors("config", "has_u1")

746

True

747

</pre></div>

748

</div>

749

</dd>

750

</dl>

729

751

</dd></dl>

730

752

731

753

785

807

</dl>

786

808

</dd></dl>

787

809

810

811

812

<tt class="descname">invalidate_extra_information</tt><big>(</big>extrainfo<big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.invalidate_extra_information">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.invalidate_extra_information" title="Permalink to this definition">¶</a></dt>

813

<dd>DOCS NEEDED

814

</dd></dl>

815

816

817

818

<tt class="descname">list_accomplishments</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.list_accomplishments">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.list_accomplishments" title="Permalink to this definition">¶</a></dt>

819

<dd>Returns a list of accomplishment IDs for the all available accomplishments. This includes all accomplishment IDs

820

from all collections.

821

822

823

824

<dt>Returns:</dt>

825

826

<li>(list) - the list of accomplishment IDs.</li>

827

</ul>

828

</dd>

829

<dt>Example:</dt>

830

831

["ubuntu-community/registered-on-launchpad", "ubuntu-community/ubuntu-member", . . .]

832

</pre></div>

833

</div>

834

</dd>

835

</dl>

836

</dd></dl>

837

838

839

840

<tt class="descname">list_collections</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.list_collections">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.list_collections" title="Permalink to this definition">¶</a></dt>

841

<dd>Returns a list of collections available. Collections are listed in their

842

unique formats (e.g. <cite>ubuntu-community</cite>).

843

844

845

846

<dt>Returns:</dt>

847

848

<li>(list) - the list of accomplishment IDs for all trophies.</li>

849

</ul>

850

</dd>

851

<dt>Example:</dt>

852

853

["ubuntu-community", "ubuntu-desktop"]

854

</pre></div>

855

</div>

856

</dd>

857

</dl>

858

</dd></dl>

859

860

861

862

<tt class="descname">list_depending_on</tt><big>(</big>accomID<big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.list_depending_on">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.list_depending_on" title="Permalink to this definition">¶</a></dt>

863

<dd>DOCS NEEDED

864

</dd></dl>

865

866

867

868

<tt class="descname">list_opportunitues</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.list_opportunitues">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.list_opportunitues" title="Permalink to this definition">¶</a></dt>

869

<dd>Returns a list of accomplishment IDs for the all available opportunities. This includes all accomplishment IDs

870

from all sets.

871

872

873

874

<dt>Returns:</dt>

875

876

<li>(list) - the list of opportunity accomplishment IDs.</li>

877

</ul>

878

</dd>

879

<dt>Example:</dt>

880

881

["ubuntu-community/registered-on-launchpad", "ubuntu-community/ubuntu-member", . . .]

882

</pre></div>

883

</div>

884

</dd>

885

</dl>

886

</dd></dl>

887

888

889

890

<tt class="descname">list_trophies</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.list_trophies">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.list_trophies" title="Permalink to this definition">¶</a></dt>

891

<dd>Returns a list of trophies for the all available accomplishments in accomplishment ID format.

892

893

894

895

<dt>Returns:</dt>

896

897

<li>(list) - the list of accomplishment IDs for all trophies.</li>

898

</ul>

899

</dd>

900

<dt>Example:</dt>

901

902

["ubuntu-community/registered-on-launchpad", "ubuntu-community/ubuntu-member", . . .]

903

</pre></div>

904

</div>

905

</dd>

906

</dl>

907

</dd></dl>

908

909

910

911

<tt class="descname">list_unlocked</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.list_unlocked">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.list_unlocked" title="Permalink to this definition">¶</a></dt>

912

<dd>Returns a list of accomplishment IDs for the all unlocked opportunities. This includes all accomplishment IDs

913

from all collections.

914

915

916

917

<dt>Returns:</dt>

918

919

<li>(list) - the list of unlocked opportunity accomplishment IDs.</li>

920

</ul>

921

</dd>

922

<dt>Example:</dt>

923

924

["ubuntu-community/registered-on-launchpad", "ubuntu-community/ubuntu-member", . . .]

925

</pre></div>

926

</div>

927

</dd>

928

</dl>

929

</dd></dl>

930

931

932

933

<tt class="descname">list_unlocked_not_completed</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/accomplishments/daemon/dbusapi.html#AccomplishmentsDBusService.list_unlocked_not_completed">[source]</a><a class="headerlink" href="#accomplishments.daemon.dbusapi.AccomplishmentsDBusService.list_unlocked_not_completed" title="Permalink to this definition">¶</a></dt>

934

<dd>Returns a list of accomplishment IDs for the all unlocked opportunities that are not completed. This includes all accomplishment IDs

935

from all collections.

936

937

938

939

<dt>Returns:</dt>

940

941

<li>(list) - the list of unlocked opportunity accomplishment IDs.</li>

942

</ul>

943

</dd>

944

<dt>Example:</dt>

945

946

["ubuntu-community/registered-on-launchpad", "ubuntu-community/ubuntu-member", . . .]

947

</pre></div>

948

</div>

949

</dd>

950

</dl>

951

</dd></dl>

952

788

953

</dd></dl>

789

954

790

955

</div>

Older »