Ubuntu Developer Portal

Documentation for service_type in OnlineAccountClient is misleading

Bug #1394454 reported by Robert Schroll
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Ubuntu Developer Portal
New
High
Unassigned

Bug Description

The documentation for the service_type argument in the OnlineAccountClient is, 'The type of service (E.g. "sharing").' But in examples of .service files, the service type is specified using the a reverse-domain-name-esque string. The documentation should be updated to reflect this usage.

Revision history for this message
Michi Henning (michihenning) wrote :

Could you be a bit more specific? You are right, the OnlineAccountClient doc says that the service type is a string such as "sharing". And in the generated doc, the example for a .service file shows:

<?xml version="1.0" encoding="UTF-8"?>
<service id="com.ubuntu.scopes.youtube_youtube">
<type>sharing</type>
<icon>youtube</icon>
<name>YouTube</name>

So, that seems all in order. Exactly where are you seeing the .service example that is wrong?

Revision history for this message
Robert Schroll (rschroll) wrote :

I have no idea what I was looking at three months ago that had the error. But a quick googling turns up this page, https://developer.ubuntu.com/en/apps/platform/guides/online-accounts-developer-guide/, which has the example service file:

<service>
  <type>ubuntu.com.developer.me.MyClick_MyApp</type>
  <provider>facebook</provider>
</service>

I can't find the example you're pointing out, but I'm probably looking in the wrong places.

Revision history for this message
Michi Henning (michihenning) wrote :

I was looking at https://developer.ubuntu.com/api/scopes/sdk-14.10/index/

See the "Example .service file" section.

The page you linked is indeed wrong, thanks for pointing that out. I'll reassign the bug.

Revision history for this message
Michi Henning (michihenning) wrote :

Please see comment #1; the correct example can be found in the unity-scopes-api doc.

affects: unity-scopes-api (Ubuntu) → developer-ubuntu-com
Changed in developer-ubuntu-com:
importance: Undecided → High
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.