Api documentation

[GoogleCodeExporter]

What feature are you requesting?
Document the JSON API.

Original issue reported on code.google.com by shuku...@gmail.com on 27 Feb 2011 at 11:14

[GoogleCodeExporter]

Original comment by shuku...@gmail.com on 28 Feb 2011 at 10:18

• Changed state: Started

[GoogleCodeExporter]

Documentation started in MediaPortal wiki: 
http://wiki.team-mediaportal.com/1_MEDIAPORTAL_1/17_Extensions/3_Plugins/WifiRem
ote

Original comment by shuku...@gmail.com on 25 Apr 2011 at 11:01

• Added labels: Maintainability

[GoogleCodeExporter]

Moved to next version as this is a task that should be considered for every 
version.

Original comment by shuku...@gmail.com on 8 May 2011 at 4:55

• Added labels: Milestone-0.2
• Removed labels: Milestone-0.1

[GoogleCodeExporter]

Rescheduled, ongoing task for each version

Original comment by shuku...@gmail.com on 22 May 2011 at 7:15

• Added labels: Milestone-0.3
• Removed labels: Milestone-0.2

[GoogleCodeExporter]

Hi Shukuyen,

I've noticed a couple of inconsistencies in the documentation but it's a closed 
Wiki so I can't fix them. Thought I'd list them here just in case you haven't 
noticed them yet.

COMMANDS:
Commandstartrepeat/Commandstoprepeat:
The "Type" of these commands are set as 'commandrepeatstart' and 
'commandrepeatstop' which are incorrect (for Sv5 anyway) and should be the same 
as their titles.

MESSAGES:
Properties/Propertychanged:
The descriptions of these look like they were originally copy/pasted from the 
Plugins message and the "Type" still says 'plugins' (not a biggie because Type 
is always obvious, but still :) ). Also the "Tags" array on the Properties 
command states 'one object per plugin'.

Great work on WifiRemote, it's the easiest API I've worked with in a long time 
-- so easy to use that I've implemented 90% of client in just a few days! :)

Original comment by nik.ro...@gmail.com on 20 Jun 2011 at 8:04

[GoogleCodeExporter]

Here's a missing one for the documentation:

MESSAGES:
Onscreenkeyboard
Notifies the client when the on-screen Mediaportal keyboard is shown or hidden. 
This would for example allow the client to show or activate its own keyboard 
for text-entry to Mediaportal and hide it when no longer required.

Fields:
* Type (string): Type of the message, always "onscreenkeyboard"
* IsActive (boolean): True if the keyboard is opening, false if it is closing

Example:
{
  "Type":"onscreenkeyboard",
  "IsActive":true
}

Original comment by nik.ro...@gmail.com on 20 Jun 2011 at 9:40

[GoogleCodeExporter]

Hey nik,ro... (how should I call you? :D), thanks a lot for your great work in 
the last days!

As far as I know the MediaPortal wiki should be writable by every MP forum 
user? If you can't edit the pages after logging in at the top maybe DieBagger 
can help there!

I will add your comments, thanks again!

Original comment by shuku...@gmail.com on 21 Jun 2011 at 9:35

[GoogleCodeExporter]

Hey Shukuyen,

My first name is Nik :) No worries, I'm really enjoying working with WiFiRemote 
and love contributing and tweaking. Unfortunately I haven't coded in C# yet 
(I'm a C++ and Qt Quick programmer) so I can't submit any complicated patches 
but will help wherever possible.

I thought that I'd be able to edit the wiki but even when I've logged in 
pressing 'Edit' it tells me I need to log in to edit. I'll contact DieBagger 
and see if he can fix it -- someone needed to fix my account when I signed up 
in the first place because of some server error, so there could be something 
wrong there.

Cheers,
Nik

Original comment by nik.ro...@gmail.com on 21 Jun 2011 at 8:57

[GoogleCodeExporter]

Original comment by shuku...@gmail.com on 11 Jul 2011 at 10:53

• Added labels: Milestone-0.4

[GoogleCodeExporter]

Documentation is at a good level now, I will close this issue because it is 
mandatory to update the documentation on every change ...

Original comment by shuku...@gmail.com on 22 Jul 2011 at 8:19

• Changed state: Done