plugins-nextcloud-mirror/spreed
1
0
Fork 0
mirror of https://github.com/nextcloud/spreed.git synced 2025-12-18 05:20:50 +01:00
Code Projects Releases Activity

Add annotations for PublicShareAuthController

Browse source 
Signed-off-by: jld3103 <jld3103yt@gmail.com>
This commit is contained in:
jld3103 2023-07-31 15:03:02 +02:00 • committed by Joas Schilling
parent d7ed6d187c
commit 5e1bb6d3bc
No known key found for this signature in database
GPG key ID: 74434EFE0D2E2205
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/Controller/PublicShareAuthController.php
View file

@ -5,6 +5,8 @@ declare(strict_types=1);
*
* @copyright Copyright (c) 2018, Daniel Calviño Sánchez (danxuliu@gmail.com)
*
* @author Kate Döen <kate.doeen@nextcloud.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
@ -52,7 +54,7 @@ class PublicShareAuthController extends OCSController {
}
/**
* Creates a new room for requesting the password of a share.
* Creates a new room for requesting the password of a share
*
* The new room is a public room associated with a "share:password" object
* with the ID of the share token. Unlike normal rooms in which the owner is
@ -63,10 +65,10 @@ class PublicShareAuthController extends OCSController {
* The share must have "send password by Talk" enabled; an error is returned
* otherwise.
*
* @param string $shareToken
* @return DataResponse the status code is "201 Created" if a new room is
* created, "200 OK" if an existing room is returned, or "404 Not
* found" if the given share was invalid.
* @param string $shareToken Token of the share
* @return DataResponse<Http::STATUS_CREATED, array{token: string, name: string, displayName: string}, array{}>|DataResponse<Http::STATUS_NOT_FOUND, array<empty>, array{}>
* 201: Room created successfully
* 404: Share not found
*/
#[PublicPage]
public function createRoom(string $shareToken): DataResponse {