/usr/share/accounts-qml-module/doc/html/qml-ubuntu-onlineaccounts-accountservicemodel.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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | <?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-service-model.cpp -->
<title>AccountServiceModel 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="#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">AccountServiceModel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AccountServiceModel-brief -->
<p>A model of the user's Online Accounts <a href="#details">More...</a></p>
<!-- @@@AccountServiceModel -->
<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-accountservicemodel-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-accountservicemodel.html#account-prop">account</a></b></b> : Account</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#accountId-prop">accountId</a></b></b> : quint32</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#applicationId-prop">applicationId</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#includeDisabled-prop">includeDisabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#provider-prop">provider</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#service-prop">service</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#serviceType-prop">serviceType</a></b></b> : string</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">variant <b><b><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#get-method">get</a></b></b>(int <i>row</i>, string <i>roleName</i>)</li>
</ul>
<!-- $$$AccountServiceModel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The <a href="qml-ubuntu-onlineaccounts-accountservicemodel.html">AccountServiceModel</a> is a model representing the user's Online Accounts services. Please note that an Online Account can offer several different services (chat, e-mail, micro-blogging, etc.); these are the items represented by this model, and not the user accounts as a whole. Since most applications are interested on a small subset of the user's accounts, <a href="qml-ubuntu-onlineaccounts-accountservicemodel.html">AccountServiceModel</a> offers some filtering functionalities: it is possible to restrict it to only one account provider, to a specific service type (for instance, an e-mail application will probably be interested in only those accounts which offer an e-mail service), or to a specific service (e.g., picasa; this is often equivalent to filtering by provider and by service-type, because it's rare for a provider to offer two different services of the same type). By default, only enabled accounts are returned. Use the <a href="qml-ubuntu-onlineaccounts-accountservicemodel.html#includeDisabled-prop">includeDisabled</a> property to list also disabled accounts; keep in mind, though, that an application should never use an account which has been disabled by the user.</p>
<p>The model defines the following roles:</p>
<ul>
<li><code>displayName</code> is the name of the account (usually the user's login)</li>
<li><code>providerName</code> is the name of the account provider (e.g., "Google")</li>
<li><code>serviceName</code> is the name of the service (e.g., "Picasa")</li>
<li><code>enabled</code></li>
<li><code>accountServiceHandle</code> is a handle to the underlying Qt object which can be used to instantiate an <a href="qml-ubuntu-onlineaccounts-accountservice.html">AccountService</a> from QML</li>
<li><code>accountId</code> is the numeric ID of the account</li>
<li><code>accountHandle</code> is a handle to the underlying Qt object which can be used to instantiate an <a href="qml-ubuntu-onlineaccounts-account.html">Account</a> from QML</li>
</ul>
<p>Examples of use:</p>
<p>1. Model of all enabled microblogging accounts:</p>
<pre class="qml"><span class="type">Item</span> {
<span class="type"><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html">AccountServiceModel</a></span> {
<span class="name">id</span>: <span class="name">accounts</span>
<span class="name">serviceType</span>: <span class="string">"microblogging"</span>
}
<span class="type">ListView</span> {
<span class="name">model</span>: <span class="name">accounts</span>
<span class="name">delegate</span>: <span class="name">Text</span> { <span class="name">text</span>: <span class="name">model</span>.<span class="name">displayName</span> <span class="operator">+</span> <span class="string">" by "</span> <span class="operator">+</span> <span class="name">model</span>.<span class="name">providerName</span> }
}
}</pre>
<p>2. List all Facebook account services:</p>
<pre class="qml"><span class="type">Item</span> {
<span class="type"><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html">AccountServiceModel</a></span> {
<span class="name">id</span>: <span class="name">accounts</span>
<span class="name">provider</span>: <span class="string">"facebook"</span>
<span class="name">includeDisabled</span>: <span class="number">true</span>
}
<span class="type">ListView</span> {
<span class="name">model</span>: <span class="name">accounts</span>
<span class="name">delegate</span>: <span class="name">Text</span> { <span class="name">text</span>: <span class="name">model</span>.<span class="name">serviceName</span> <span class="operator">+</span> <span class="string">" on "</span> <span class="operator">+</span> <span class="name">model</span>.<span class="name">displayName</span> }
}
}</pre>
<p>3. List all Flickr accounts enabled for uploading:</p>
<pre class="qml"><span class="type">Item</span> {
<span class="type"><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html">AccountServiceModel</a></span> {
<span class="name">id</span>: <span class="name">accounts</span>
<span class="name">service</span>: <span class="string">"flickr-sharing"</span>
}
<span class="type">ListView</span> {
<span class="name">model</span>: <span class="name">accounts</span>
<span class="name">delegate</span>: <span class="name">Rectangle</span> {
<span class="name">id</span>: <span class="name">rect</span>
<span class="type">Text</span> { <span class="name">text</span>: <span class="name">rect</span>.<span class="name">model</span>.<span class="name">displayName</span> }
<span class="type"><a href="qml-ubuntu-onlineaccounts-accountservice.html">AccountService</a></span> {
<span class="name">id</span>: <span class="name">accountService</span>
<span class="name">objectHandle</span>: <span class="name">rect</span>.<span class="name">model</span>.<span class="name">accountServiceHandle</span>
<span class="name">onAuthenticated</span>: { <span class="name">console</span>.<span class="name">log</span>(<span class="string">"Access token is "</span> <span class="operator">+</span> <span class="name">reply</span>.<span class="name">AccessToken</span>) }
<span class="name">onAuthenticationError</span>: { <span class="name">console</span>.<span class="name">log</span>(<span class="string">"Authentication failed, code "</span> <span class="operator">+</span> <span class="name">error</span>.<span class="name">code</span>) }
}
<span class="type">MouseArea</span> {
<span class="name">anchors</span>.fill: <span class="name">parent</span>
<span class="name">onClicked</span>: <span class="name">accountService</span>.<span class="name">authenticate</span>()
}
}
}
}</pre>
<p>4. List all the online accounts, without their services:</p>
<pre class="qml"><span class="type">Item</span> {
<span class="type"><a href="qml-ubuntu-onlineaccounts-accountservicemodel.html">AccountServiceModel</a></span> {
<span class="name">id</span>: <span class="name">accounts</span>
<span class="name">service</span>: <span class="string">"global"</span>
}
<span class="type">ListView</span> {
<span class="name">model</span>: <span class="name">accounts</span>
<span class="name">delegate</span>: <span class="name">Rectangle</span> {
<span class="name">id</span>: <span class="name">rect</span>
<span class="type">Text</span> { <span class="name">text</span>: <span class="name">account</span>.<span class="name">displayName</span> }
<span class="type"><a href="qml-ubuntu-onlineaccounts-account.html">Account</a></span> {
<span class="name">id</span>: <span class="name">account</span>
<span class="name">objectHandle</span>: <span class="name">rect</span>.<span class="name">model</span>.<span class="name">accountHandle</span>
}
}
}
}</pre>
<!-- @@@AccountServiceModel -->
<h2>Property Documentation</h2>
<!-- $$$account -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="account-prop"><td class="tblQmlPropNode"><p><a name="account-prop"></a><span class="name">account</span> : <span class="type"><a href="qml-ubuntu-onlineaccounts-account.html">Account</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>If set, the model will list only those accounts services available in the given account.</p>
</div></div><!-- @@@account -->
<br/>
<!-- $$$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">quint32</span></p></td></tr></table></div></div><div class="qmldoc"><p>If set, the model will list only those accounts services available in the given account.</p>
</div></div><!-- @@@accountId -->
<br/>
<!-- $$$applicationId -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="applicationId-prop"><td class="tblQmlPropNode"><p><a name="applicationId-prop"></a><span class="name">applicationId</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>If set, the model will only show those account services which are relevant for the given <i>applicationId</i>. This means that an account service will only be shown if it can be used by the application, as described in the application's manifest file.</p>
</div></div><!-- @@@applicationId -->
<br/>
<!-- $$$includeDisabled -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="includeDisabled-prop"><td class="tblQmlPropNode"><p><a name="includeDisabled-prop"></a><span class="name">includeDisabled</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>If true, even disabled account services will be listed. Note that an application should never use a disabled account.</p>
<p>By default, this property is false.</p>
</div></div><!-- @@@includeDisabled -->
<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">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>If set, the model will list only those accounts services provided by this provider.</p>
</div></div><!-- @@@provider -->
<br/>
<!-- $$$service -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="service-prop"><td class="tblQmlPropNode"><p><a name="service-prop"></a><span class="name">service</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>If set, the model will list only those accounts services for this specific service.</p>
</div></div><!-- @@@service -->
<br/>
<!-- $$$serviceType -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="serviceType-prop"><td class="tblQmlPropNode"><p><a name="serviceType-prop"></a><span class="name">serviceType</span> : <span class="type">string</span></p></td></tr></table></div></div><div class="qmldoc"><p>If set, the model will list only those accounts services supporting this service type. Each provider-specific service is an instance of a generic service type (such as "e-mail", "IM", etc.) which identifies the main functionality provided by the service.</p>
</div></div><!-- @@@serviceType -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$get -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="get-method"><td class="tblQmlFuncNode"><p><a name="get-method"></a><span class="type">variant</span> <span class="name">get</span>(<span class="type">int</span><i> row</i>, <span class="type">string</span><i> roleName</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Returns the data at <i>row</i> for the role <i>roleName</i>.</p>
</div></div><!-- @@@get -->
<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>
|