diff options
author | Joas Schilling <coding@schilljs.com> | 2017-03-22 19:08:13 +0300 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2017-03-26 21:05:33 +0300 |
commit | e62b3a86236331c87fb0e9005e953035d7fa1a76 (patch) | |
tree | 91670c581d3ffaf8bcfc0d091359b54f60883642 /README.md | |
parent | d3231ad03921e9675d40254827c48c616284d338 (diff) |
Adjust README.md
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 13 insertions, 1 deletions
@@ -31,12 +31,24 @@ curl -H "OCS-APIRequest: true" \ <name>Homepage</name> <url>https://localhost/index.php</url> <lang>en</lang> - <icon>external.svg</icon> + <type>link</type> + <icon>https://localhost/external.svg</icon> </element> </data> </ocs> ``` +#### Explanation + +| Field | Type | Description | +| ----- | ------ | ---------------------------------------- | +| id | int | Numeric identifier of the site | +| name | string | Name of the site, ready to use | +| url | string | URL that should be framed/linked to | +| lang | string | Language code for which this link is valid (empty string means all languages) | +| type | string | Can be one of `link`, `settings` or `quota`; see [this issue](https://github.com/nextcloud/external/issues/7) for details | +| icon | string | Full URL of the icon that should be shown next to the name of the link | + ### Capability The app registers a capability, so clients can check that before making the actual OCS request: |