/usr/share/accounts-qml-module/doc/html/qml-ubuntu-onlineaccounts-account.html is in accounts-qml-module-doc 0.6+16.04.20151106-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- account.cpp -->
<title>Account QML Type | OnlineAccounts QML API </title>
<link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Ubuntu:400,400italic">
<link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Ubuntu+Mono:400">
<link rel="stylesheet" type="text/css" href="style/reset.css" />
<link rel="stylesheet" type="text/css" href="style/qtquick.css" />
<link rel="stylesheet" type="text/css" href="style/base.css" />
<link rel="stylesheet" type="text/css" href="style/scratch.css" />
</head>
<header>
<div class="header-login">
<ul>
<li><a href="https://myapps.developer.ubuntu.com/openid/login/?next=/dev">Sign in or register</a></li>
</ul>
</div>
<div class="header-navigation">
<div>
<nav role="navigation">
<ul>
<li class="page_item page-item-5"><a href="http://developer.ubuntu.com/">Home</a></li>
<li class="page_item page-item-7"><a href="http://developer.ubuntu.com/get-started/">Get started</a></li>
<li class="page_item page-item-9"><a href="http://developer.ubuntu.com/resources/">Resources</a></li>
<li class="page_item page-item-11"><a href="http://developer.ubuntu.com/publish/">Publish</a></li>
<li class="page_item page-item-13"><a href="http://developer.ubuntu.com/community/">Community</a></li>
<li><a href="https://myapps.developer.ubuntu.com/dev">My Apps</a></li>
<li>
<form id="form-search" method="get" action="/">
<fieldset>
<input id="input-search" type="text" name="s" value="Search" />
</fieldset>
</form>
</li>
</ul>
</nav>
<a class="logo-ubuntu" href="/"><img src="http://developer.ubuntu.com/wp-content/themes/wordpress-theme-ubuntudeveloper/img/logo-ubuntu.png" width="119" height="27" alt="Ubuntu logo" /></a>
<h2><a href="/">App Developer</a></h2>
</div>
</div>
</header>
<div class="wrapper">
<div class="main-content">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Account QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Account-brief -->
<p>Represents an instance of an online account. <a href="#details">More...</a></p>
<!-- @@@Account -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Ubuntu.OnlineAccounts 0.1</td></tr></table></div><ul>
<li><a href="qml-ubuntu-onlineaccounts-account-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-account.html#accountId-prop">accountId</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-account.html#accountServiceHandle-prop">accountServiceHandle</a></b></b> : object</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-account.html#displayName-prop">displayName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-account.html#enabled-prop">enabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-account.html#objectHandle-prop">objectHandle</a></b></b> : object</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-account.html#provider-prop">provider</a></b></b> : jsobject</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-account.html#synced-signal">synced</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-ubuntu-onlineaccounts-account.html#remove-method">remove</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-ubuntu-onlineaccounts-account.html#sync-method">sync</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-ubuntu-onlineaccounts-account.html#updateDisplayName-method">updateDisplayName</a></b></b>(string <i>displayName</i>)</li>
<li class="fn">void <b><b><a href="qml-ubuntu-onlineaccounts-account.html#updateEnabled-method">updateEnabled</a></b></b>(bool <i>enabled</i>)</li>
</ul>
<!-- $$$Account-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The Account element represents an online account. It is functional only if its <i>objectHandle</i> property is set to a valid account, which can be obtained with Manager.loadAccount() or Manager.createAccount().</p>
<!-- @@@Account -->
<h2>Property Documentation</h2>
<!-- $$$accountId -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="accountId-prop"><td class="tblQmlPropNode"><p><a name="accountId-prop"></a><span class="name">accountId</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>The account's numeric ID. This is 0 until the account has been stored into the DB.</p>
</div></div><!-- @@@accountId -->
<br/>
<!-- $$$accountServiceHandle -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="accountServiceHandle-prop"><td class="tblQmlPropNode"><p><a name="accountServiceHandle-prop"></a><span class="name">accountServiceHandle</span> : <span class="type">object</span></p></td></tr></table></div></div><div class="qmldoc"><p>A C++ object which can be used to instantiate an <a href="qml-ubuntu-onlineaccounts-accountservice.html">AccountService</a> by setting it as the value for the <a href="qml-ubuntu-onlineaccounts-accountservice.html#objectHandle-prop">AccountService::objectHandle</a> property.</p>
</div></div><!-- @@@accountServiceHandle -->
<br/>
<!-- $$$displayName -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="displayName-prop"><td class="tblQmlPropNode"><p><a name="displayName-prop"></a><span class="name">displayName</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>The account's display name (usually the user's login or ID).</p>
</div></div><!-- @@@displayName -->
<br/>
<!-- $$$enabled -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="enabled-prop"><td class="tblQmlPropNode"><p><a name="enabled-prop"></a><span class="name">enabled</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This read-only property tells whether the Account is enabled. An application shouldn't use an Account which is disabled.</p>
</div></div><!-- @@@enabled -->
<br/>
<!-- $$$objectHandle -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="objectHandle-prop"><td class="tblQmlPropNode"><p><a name="objectHandle-prop"></a><span class="name">objectHandle</span> : <span class="type">object</span></p></td></tr></table></div></div><div class="qmldoc"><p>An opaque handle to the underlying C++ object. Until the property is set, the Account element is uninitialized. Similarly, if the C++ object is destroyed, expect the Account to become invalid.</p>
</div></div><!-- @@@objectHandle -->
<br/>
<!-- $$$provider -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="provider-prop"><td class="tblQmlPropNode"><p><a name="provider-prop"></a><span class="name">provider</span> : <span class="type">jsobject</span></p></td></tr></table></div></div><div class="qmldoc"><p>An immutable object representing the provider which provides the account. The returned object will have at least these members:</p>
<ul>
<li><code>id</code> is the unique identified for this provider</li>
<li><code>displayName</code></li>
<li><code>iconName</code></li>
</ul>
</div></div><!-- @@@provider -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$synced -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="synced-signal"><td class="tblQmlFuncNode"><p><a name="synced-signal"></a><span class="name">synced</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>Emitted when the account changes have been stored into the permanent storage.</p>
</div></div><!-- @@@synced -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$remove -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="remove-method"><td class="tblQmlFuncNode"><p><a name="remove-method"></a><span class="type">void</span> <span class="name">remove</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>Deletes the account from the permanent storage. This method accepts an optional parameter, which tells whether the credentials associated with the account should also be removed:</p>
<ul>
<li><code>Account.RemoveAccountOnly</code></li>
<li><code>Account.RemoveCredentials</code> - the default</li>
</ul>
</div></div><!-- @@@remove -->
<br/>
<!-- $$$sync -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="sync-method"><td class="tblQmlFuncNode"><p><a name="sync-method"></a><span class="type">void</span> <span class="name">sync</span>()</p></td></tr></table></div></div><div class="qmldoc"><p>Writes the changes to the permanent account storage.</p>
</div></div><!-- @@@sync -->
<br/>
<!-- $$$updateDisplayName -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="updateDisplayName-method"><td class="tblQmlFuncNode"><p><a name="updateDisplayName-method"></a><span class="type">void</span> <span class="name">updateDisplayName</span>(<span class="type">string</span><i> displayName</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Changes the display name of the account.</p>
<p><b>See also </b><a href="qml-ubuntu-onlineaccounts-account.html#sync-method">sync()</a>.</p>
</div></div><!-- @@@updateDisplayName -->
<br/>
<!-- $$$updateEnabled -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="updateEnabled-method"><td class="tblQmlFuncNode"><p><a name="updateEnabled-method"></a><span class="type">void</span> <span class="name">updateEnabled</span>(<span class="type">bool</span><i> enabled</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Enables or disables the account.</p>
<p><b>See also </b><a href="qml-ubuntu-onlineaccounts-account.html#sync-method">sync()</a>.</p>
</div></div><!-- @@@updateEnabled -->
<br/>
</div></div>
<div class="shadow"></div>
<footer>
<div>
<nav role="navigation" class="clearfix">
<ul>
<li><a href="/get-started">Get started</a></li>
<li class="page_item page-item-16"><a href="http://developer.ubuntu.com/get-started/quickly-workflow/">Quickly workflow</a></li>
<li class="page_item page-item-18"><a href="http://developer.ubuntu.com/get-started/qt-creator/">Qt Creator</a></li>
<li class="page_item page-item-20"><a href="http://developer.ubuntu.com/get-started/eclipse/">Eclipse</a></li>
<li class="page_item page-item-22"><a href="http://developer.ubuntu.com/get-started/monodevelop/">MonoDevelop</a></li>
</ul>
<ul>
<li><a href="/resources">Resources</a></li>
<li><a href="/resources/tools/quickly">Quickly</a></li>
<li><a href="/resources/platform/api">API</a></li>
<li><a href="/resources/platform/documentation/platform-diagram">Platform overview</a></li>
</ul>
<ul>
<li><a href="/publish">Publish</a></li>
<li class="page_item page-item-24"><a href="http://developer.ubuntu.com/publish/commercial-software-faqs/">Commercial software FAQs</a></li>
<li class="page_item page-item-34"><a href="http://developer.ubuntu.com/publish/application-states/">Application states</a></li>
<li class="page_item page-item-577"><a href="http://developer.ubuntu.com/publish/my-apps-packages/">Uploading your app</a></li>
<li class="page_item page-item-404"><a href="http://developer.ubuntu.com/publish/ubuntu-software-centre/">Ubuntu Software Centre</a></li>
<li class="page_item page-item-427"><a href="http://developer.ubuntu.com/publish/licence-key-infrastructure/">Licence key infrastructure</a></li>
<li class="page_item page-item-1230"><a href="http://developer.ubuntu.com/publish/updating-your-app/">Updating your app</a></li>
</ul>
<ul>
<li><a href="/community">Community</a></li>
<li class="page_item page-item-28"><a href="http://developer.ubuntu.com/community/app-developer-blog/">App Developer Blog</a></li>
<li class="page_item page-item-30"><a href="http://developer.ubuntu.com/community/submit-a-tutorial/">Submit a tutorial</a></li>
<li class="page_item page-item-32"><a href="http://developer.ubuntu.com/community/app-review-board-charter/">App Review Board charter</a></li>
<li class="page_item page-item-2987"><a href="http://developer.ubuntu.com/community/on-air/">On air</a>
<ul class='children'>
<li class="page_item page-item-3066"><a href="http://developer.ubuntu.com/community/on-air/recordings/">Recordings</a></li>
</ul>
</li>
</ul>
<ul class="last">
<li><a href="https://myapps.developer.ubuntu.com/dev">My Apps</a></li>
<li><a href="https://myapps.developer.ubuntu.com/openid/login/?next=/dev">Sign in or register</a></li>
<li><a href="https://myapps.developer.ubuntu.com/dev/account">My account</a></li>
</ul>
</nav>
<p>© 2013 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd. <a class="link-bug" href="https://bugs.launchpad.net/ubuntudeveloperportal/+filebug">Report a bug on this site</a></p>
</div>
</footer>
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js"></script>
<script type="text/javascript" src="http://developer.ubuntu.com/wp-content/themes/wordpress-theme-ubuntudeveloper/js/base.js"></script>
</body>
</html>
|