Skip to content

Commit

Permalink
Automated Spec Update (#253)
Browse files Browse the repository at this point in the history
b343fc634be6702d3e58c2eaaf6cb622e8642512

 Change Notes:

shared_links Namespace:
- Update comments

Co-authored-by: Scott Erickson <serickson@dropbox.com>

Co-authored-by: DropboxBot <DropboxBot@users.noreply.github.com>
Co-authored-by: Scott Erickson <serickson@dropbox.com>
  • Loading branch information
3 people authored Jul 14, 2021
1 parent 30d03a2 commit 13b5803
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public class CreateSharedLinkArg
/// class.</para>
/// </summary>
/// <param name="path">The path to share.</param>
/// <param name="shortUrl">Whether to return a shortened URL.</param>
/// <param name="shortUrl">The short url</param>
/// <param name="pendingUpload">If it's okay to share a path that does not yet exist,
/// set this to either <see cref="Dropbox.Api.Sharing.PendingUploadMode.File" /> or
/// <see cref="Dropbox.Api.Sharing.PendingUploadMode.Folder" /> to indicate whether to
Expand Down Expand Up @@ -69,7 +69,7 @@ public CreateSharedLinkArg()
public string Path { get; protected set; }

/// <summary>
/// <para>Whether to return a shortened URL.</para>
/// <para>Gets the short url of the create shared link arg</para>
/// </summary>
public bool ShortUrl { get; protected set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -538,10 +538,6 @@ public ShareFolderJobStatus EndCheckShareJobStatus(sys.IAsyncResult asyncResult)
/// <para>Create a shared link.</para>
/// <para>If a shared link already exists for the given path, that link is
/// returned.</para>
/// <para>Note that in the returned <see cref="PathLinkMetadata" />, the <see
/// cref="Dropbox.Api.Sharing.PathLinkMetadata.Url" /> field is the shortened URL if
/// <see cref="Dropbox.Api.Sharing.CreateSharedLinkArg.ShortUrl" /> argument is set to
/// <c>true</c>.</para>
/// <para>Previously, it was technically possible to break a shared link by moving or
/// renaming the corresponding file or folder. In the future, this will no longer be
/// the case, so your app shouldn't rely on this behavior. Instead, if your app needs
Expand Down Expand Up @@ -582,10 +578,6 @@ public sys.IAsyncResult BeginCreateSharedLink(CreateSharedLinkArg createSharedLi
/// <para>Create a shared link.</para>
/// <para>If a shared link already exists for the given path, that link is
/// returned.</para>
/// <para>Note that in the returned <see cref="PathLinkMetadata" />, the <see
/// cref="Dropbox.Api.Sharing.PathLinkMetadata.Url" /> field is the shortened URL if
/// <see cref="Dropbox.Api.Sharing.CreateSharedLinkArg.ShortUrl" /> argument is set to
/// <c>true</c>.</para>
/// <para>Previously, it was technically possible to break a shared link by moving or
/// renaming the corresponding file or folder. In the future, this will no longer be
/// the case, so your app shouldn't rely on this behavior. Instead, if your app needs
Expand All @@ -594,7 +586,7 @@ public sys.IAsyncResult BeginCreateSharedLink(CreateSharedLinkArg createSharedLi
/// />.</para>
/// </summary>
/// <param name="path">The path to share.</param>
/// <param name="shortUrl">Whether to return a shortened URL.</param>
/// <param name="shortUrl">The short url</param>
/// <param name="pendingUpload">If it's okay to share a path that does not yet exist,
/// set this to either <see cref="Dropbox.Api.Sharing.PendingUploadMode.File" /> or
/// <see cref="Dropbox.Api.Sharing.PendingUploadMode.Folder" /> to indicate whether to
Expand All @@ -620,7 +612,7 @@ public t.Task<PathLinkMetadata> CreateSharedLinkAsync(string path,
/// <para>Begins an asynchronous send to the create shared link route.</para>
/// </summary>
/// <param name="path">The path to share.</param>
/// <param name="shortUrl">Whether to return a shortened URL.</param>
/// <param name="shortUrl">The short url</param>
/// <param name="pendingUpload">If it's okay to share a path that does not yet exist,
/// set this to either <see cref="Dropbox.Api.Sharing.PendingUploadMode.File" /> or
/// <see cref="Dropbox.Api.Sharing.PendingUploadMode.Folder" /> to indicate whether to
Expand Down Expand Up @@ -1271,7 +1263,6 @@ public SharedLinkMetadata EndGetSharedLinkMetadata(sys.IAsyncResult asyncResult)
/// including collection links, up to a maximum of 1000 links.</para>
/// <para>If a non-empty path is given, returns a list of all shared links that allow
/// access to the given path. Collection links are never returned in this case.</para>
/// <para>Note that the url field in the response is never the shortened URL.</para>
/// </summary>
/// <param name="getSharedLinksArg">The request parameters</param>
/// <returns>The task that represents the asynchronous send operation. The TResult
Expand Down Expand Up @@ -1309,7 +1300,6 @@ public sys.IAsyncResult BeginGetSharedLinks(GetSharedLinksArg getSharedLinksArg,
/// including collection links, up to a maximum of 1000 links.</para>
/// <para>If a non-empty path is given, returns a list of all shared links that allow
/// access to the given path. Collection links are never returned in this case.</para>
/// <para>Note that the url field in the response is never the shortened URL.</para>
/// </summary>
/// <param name="path">See <see
/// cref="Dropbox.Api.Sharing.Routes.SharingUserRoutes.GetSharedLinksAsync" />
Expand Down
2 changes: 1 addition & 1 deletion spec
Submodule spec updated 1 files
+1 −8 shared_links.stone

0 comments on commit 13b5803

Please sign in to comment.