User:Ncarthy: Difference between revisions

Revision as of 00:39, 19 February 2017

Retrieve recently added songs
Permissions:

ReadData

Parameters:

[ List.Amount albumlimit = -1 ]
[ Audio.Fields.Song properties ]
[ List.Limits limits ]
[ List.Sort sort ]

Returns:

{

 "properties": {
   "limits": {
     "$ref": "List.LimitsReturned",
     "required": true
   },
   "songs": {
     "items": {
       "$ref": "Audio.Details.Song"
     },
     "type": "array"
   }
 },
 "type": "object"

}

JSON Schema Description

{
  "description": "Retrieve recently added songs",
  "permission": "ReadData",
  "type": "method",
  "params": [
    {
      "default": "-1",
      "name": "albumlimit",
      "required": false,
      "$ref": "List.Amount"
    },
    {
      "name": "properties",
      "required": false,
      "$ref": "Audio.Fields.Song"
    },
    {
      "name": "limits",
      "required": false,
      "$ref": "List.Limits"
    },
    {
      "name": "sort",
      "required": false,
      "$ref": "List.Sort"
    }
  ],
  "returns": {
    "properties": {
      "limits": {
        "$ref": "List.LimitsReturned",
        "required": true
      },
      "songs": {
        "items": {
          "$ref": "Audio.Details.Song"
        },
        "type": "array"
      }
    },
    "type": "object"
  }
}

@@ Line 1: / Line 1: @@
-Executes the given addon with the given parameters (if possible)<br />
+Retrieve recently added songs<br />
 '''Permissions:'''
-* ExecuteAddon
+* ReadData
 '''Parameters:'''
 <div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
-[
+# [ ''[[#List.Amount|List.Amount]]'' albumlimit = -1 ]
-  {
+# [ ''[[#Audio.Fields.Song|Audio.Fields.Song]]'' properties ]
-    "name": "addonid",
+# [ ''[[#List.Limits|List.Limits]]'' limits ]
-    "required": true,
+# [ ''[[#List.Sort|List.Sort]]'' sort ]
-     "type": "string"
+</div>
-  },
+'''Returns:'''
-  {
+<div style="margin-left: 20px; width: 60%; padding: 0px 5px 0px 5px; border-width: 1px; border-style: solid; border-color: #AAAAAA">
-    "default": "",
+{
-    "name": "params",
+  "properties": {
-     "type": [
+     "limits": {
-       {
+      "$ref": "List.LimitsReturned",
-        "additionalProperties": {
+      "required": true
-          "default": "",
+    },
-          "type": "string"
+     "songs": {
-        },
+       "items": {
-         "type": "object"
+         "$ref": "Audio.Details.Song"
        },
-       {
+       "type": "array"
-        "items": {
+    }
-          "type": "string"
-        },
-        "type": "array"
-      },
-      {
-        "description": "URL path (must start with / or ?",
-        "type": "string"
-      }
-    ]
    },
-   {
+   "type": "object"
-    "default": false,
+}
-    "name": "wait",
-    "type": "boolean"
-  }
-]
 </div>
-'''Returns:''' ''{
+{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{
-  "type": "string"
+  "description": "Retrieve recently added songs",
-}
+  "permission": "ReadData",
-''
+  "type": "method",
-{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|JSON Schema Description|<syntaxhighlight lang="javascript" enclose="div">{{
    "params": [
      {
-       "name": "addonid",
+      "default": "-1",
-       "required": true,
+      "name": "albumlimit",
-       "type": "string"
+      "required": false,
+      "$ref": "List.Amount"
+    },
+    {
+       "name": "properties",
+       "required": false,
+       "$ref": "Audio.Fields.Song"
      },
      {
-       "default": "",
+       "name": "limits",
-       "name": "params",
+       "required": false,
-       "type": [
+       "$ref": "List.Limits"
-        {
-          "additionalProperties": {
-            "default": "",
-            "type": "string"
-          },
-          "type": "object"
-        },
-        {
-          "items": {
-            "type": "string"
-          },
-          "type": "array"
-        },
-        {
-          "description": "URL path (must start with / or ?",
-          "type": "string"
-        }
-      ]
      },
      {
-       "default": false,
+       "name": "sort",
-       "name": "wait",
+       "required": false,
-       "type": "boolean"
+       "$ref": "List.Sort"
      }
-   ]
+   ],
-}}</syntaxhighlight>}}
+  "returns": {
+    "properties": {
+      "limits": {
+        "$ref": "List.LimitsReturned",
+        "required": true
+      },
+      "songs": {
+        "items": {
+          "$ref": "Audio.Details.Song"
+        },
+        "type": "array"
+      }
+    },
+    "type": "object"
+  }
+}</syntaxhighlight>}}

User:Ncarthy: Difference between revisions

Revision as of 00:39, 19 February 2017

Navigation menu

Search