diff options
Diffstat (limited to 'lib/public/RichObjectStrings/Definitions.php')
| -rw-r--r-- | lib/public/RichObjectStrings/Definitions.php | 163 |
1 files changed, 136 insertions, 27 deletions
diff --git a/lib/public/RichObjectStrings/Definitions.php b/lib/public/RichObjectStrings/Definitions.php index 263913f27e1..d6717e54aea 100644 --- a/lib/public/RichObjectStrings/Definitions.php +++ b/lib/public/RichObjectStrings/Definitions.php @@ -1,31 +1,9 @@ <?php + /** - * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com> - * - * @author Joas Schilling <coding@schilljs.com> - * @author Julius Härtl <jus@bitgrid.net> - * @author Maxence Lange <maxence@nextcloud.com> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Thomas Citharel <nextcloud@tcit.fr> - * @author Vincent Petry <vincent@nextcloud.com> - * - * @license GNU AGPL version 3 or any later version - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as - * published by the Free Software Foundation, either version 3 of the - * License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * + * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ - namespace OCP\RichObjectStrings; /** @@ -84,7 +62,8 @@ class Definitions { 'parameters' => [ 'id' => [ 'since' => '11.0.0', - 'required' => true, 'description' => 'The id used to identify the announcement on the instance', + 'required' => true, + 'description' => 'The id used to identify the announcement on the instance', 'example' => '42', ], 'name' => [ @@ -108,7 +87,8 @@ class Definitions { 'parameters' => [ 'id' => [ 'since' => '11.0.0', - 'required' => true, 'description' => 'The app id', + 'required' => true, + 'description' => 'The app id', 'example' => 'updatenotification', ], 'name' => [ @@ -192,6 +172,18 @@ class Definitions { 'description' => 'The link to the conversation', 'example' => 'https://localhost/index.php/call/R4nd0mToken', ], + 'icon-url' => [ + 'since' => '27.0.0', + 'required' => false, + 'description' => 'The icon url to use as avatar', + 'example' => 'https://localhost/ocs/v2.php/apps/spreed/api/v1/room/R4nd0mToken/avatar' + ], + 'message-id' => [ + 'since' => '27.0.0', + 'required' => false, + 'description' => 'The id of a message that was referred to', + 'example' => '12345', + ], ], ], 'circle' => [ @@ -347,6 +339,73 @@ class Definitions { 'description' => 'Whether or not a preview is available. If `no` the mimetype icon should be used', 'example' => 'yes', ], + 'mtime' => [ + 'since' => '25.0.0', + 'required' => false, + 'description' => 'The mtime of the file/folder as unix timestamp', + 'example' => '1661854213', + ], + 'etag' => [ + 'since' => '25.0.0', + 'required' => false, + 'description' => 'The ETag of the file/folder', + 'example' => 'abcdefghi', + ], + 'permissions' => [ + 'since' => '25.0.0', + 'required' => false, + 'description' => 'The permissions on the file/folder', + 'example' => '3', + ], + 'width' => [ + 'since' => '29.0.0', + 'required' => false, + 'description' => 'The width in pixels if the file is an image', + 'example' => '1920', + ], + 'height' => [ + 'since' => '29.0.0', + 'required' => false, + 'description' => 'The height in pixels if the file is an image', + 'example' => '1080', + ], + 'blurhash' => [ + 'since' => '30.0.0', + 'required' => false, + 'description' => 'The blurhash of the image', + 'example' => 'LEHV9uae2yk8pyo0adR*.7kCMdnj', + ], + 'hide-download' => [ + 'since' => '31.0.5', + 'required' => false, + 'description' => 'Whether the download option should be hidden. If not set to `yes` the option can be shown', + 'example' => 'yes', + ], + ], + ], + 'forms-form' => [ + 'author' => 'Nextcloud', + 'app' => 'forms', + 'since' => '21.0.1', + 'parameters' => [ + 'id' => [ + 'since' => '21.0.1', + 'required' => true, + 'description' => 'The form-hash of the form', + 'example' => 'q72GGqbfbLBC6xNB', + ], + 'name' => [ + 'since' => '21.0.1', + 'required' => true, + 'description' => 'The title of the form', + 'example' => 'Nice Form', + ], + 'link' => [ + 'since' => '21.0.1', + 'required' => true, + 'description' => 'The full URL to the board', + 'example' => 'http://localhost/index.php/apps/forms/q72GGqbfbLBC6xNB', + ], ], ], 'guest' => [ @@ -393,6 +452,37 @@ class Definitions { ], ], ], + 'geo-location' => [ + 'author' => 'Nextcloud', + 'app' => 'core', + 'since' => '22.0.0', + 'parameters' => [ + 'id' => [ + 'since' => '22.0.0', + 'required' => true, + 'description' => 'The geo URI (https://en.wikipedia.org/wiki/Geo_URI_scheme) to identify the location', + 'example' => 'geo:52.5450511,13.3741463', + ], + 'name' => [ + 'since' => '22.0.0', + 'required' => true, + 'description' => 'A description of the location', + 'example' => 'Nextcloud Berlin Office', + ], + 'latitude' => [ + 'since' => '22.0.0', + 'required' => true, + 'description' => 'The latitude of the location MUST be the same as in the id', + 'example' => '52.5450511', + ], + 'longitude' => [ + 'since' => '22.0.0', + 'required' => true, + 'description' => 'The longitude of the location MUST be the same as in the id', + 'example' => '13.3741463', + ], + ], + ], 'open-graph' => [ 'author' => 'Maxence Lange', 'app' => 'mood', @@ -523,6 +613,25 @@ class Definitions { ], ], ], + 'talk-poll' => [ + 'author' => 'Nextcloud', + 'app' => 'talk', + 'since' => '25.0.0', + 'parameters' => [ + 'id' => [ + 'since' => '25.0.0', + 'required' => true, + 'description' => 'The id used to identify the poll on the instance', + 'example' => '12345', + ], + 'name' => [ + 'since' => '25.0.0', + 'required' => true, + 'description' => 'The poll question', + 'example' => 'What is the question?', + ], + ], + ], 'user' => [ 'author' => 'Nextcloud', 'app' => 'core', |