Skip to content

Latest commit

 

History

History
185 lines (120 loc) · 7.32 KB

SharedLinksFolders.md

File metadata and controls

185 lines (120 loc) · 7.32 KB

ISharedLinksFoldersManager

Find folder for shared link

Return the folder represented by a shared link.

A shared folder can be represented by a shared link, which can originate within the current enterprise or within another.

This endpoint allows an application to retrieve information about a shared folder when only given a shared link.

This operation is performed by calling function FindFolderForSharedLink.

See the endpoint docs at API Reference.

await userClient.SharedLinksFolders.FindFolderForSharedLinkAsync(queryParams: new FindFolderForSharedLinkQueryParams(), headers: new FindFolderForSharedLinkHeaders(boxapi: string.Concat("shared_link=", NullableUtils.Unwrap(folderFromApi.SharedLink).Url, "&shared_link_password=Secret123@")));

Arguments

  • queryParams FindFolderForSharedLinkQueryParams
    • Query parameters of findFolderForSharedLink method
  • headers FindFolderForSharedLinkHeaders
    • Headers of findFolderForSharedLink method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type FolderFull.

Returns a full folder resource if the shared link is valid and the user has access to it.

Get shared link for folder

Gets the information for a shared link on a folder.

This operation is performed by calling function GetSharedLinkForFolder.

See the endpoint docs at API Reference.

await client.SharedLinksFolders.GetSharedLinkForFolderAsync(folderId: folder.Id, queryParams: new GetSharedLinkForFolderQueryParams(fields: "shared_link"));

Arguments

  • folderId string
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • queryParams GetSharedLinkForFolderQueryParams
    • Query parameters of getSharedLinkForFolder method
  • headers GetSharedLinkForFolderHeaders
    • Headers of getSharedLinkForFolder method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type FolderFull.

Returns the base representation of a folder with the additional shared link information.

Add shared link to folder

Adds a shared link to a folder.

This operation is performed by calling function AddShareLinkToFolder.

See the endpoint docs at API Reference.

await client.SharedLinksFolders.AddShareLinkToFolderAsync(folderId: folder.Id, requestBody: new AddShareLinkToFolderRequestBody() { SharedLink = new AddShareLinkToFolderRequestBodySharedLinkField() { Access = AddShareLinkToFolderRequestBodySharedLinkAccessField.Open, Password = "Secret123@" } }, queryParams: new AddShareLinkToFolderQueryParams(fields: "shared_link"));

Arguments

  • folderId string
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • requestBody AddShareLinkToFolderRequestBody
    • Request body of addShareLinkToFolder method
  • queryParams AddShareLinkToFolderQueryParams
    • Query parameters of addShareLinkToFolder method
  • headers AddShareLinkToFolderHeaders
    • Headers of addShareLinkToFolder method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type FolderFull.

Returns the base representation of a folder with a new shared link attached.

Update shared link on folder

Updates a shared link on a folder.

This operation is performed by calling function UpdateSharedLinkOnFolder.

See the endpoint docs at API Reference.

await client.SharedLinksFolders.UpdateSharedLinkOnFolderAsync(folderId: folder.Id, requestBody: new UpdateSharedLinkOnFolderRequestBody() { SharedLink = new UpdateSharedLinkOnFolderRequestBodySharedLinkField() { Access = UpdateSharedLinkOnFolderRequestBodySharedLinkAccessField.Collaborators } }, queryParams: new UpdateSharedLinkOnFolderQueryParams(fields: "shared_link"));

Arguments

  • folderId string
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • requestBody UpdateSharedLinkOnFolderRequestBody
    • Request body of updateSharedLinkOnFolder method
  • queryParams UpdateSharedLinkOnFolderQueryParams
    • Query parameters of updateSharedLinkOnFolder method
  • headers UpdateSharedLinkOnFolderHeaders
    • Headers of updateSharedLinkOnFolder method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type FolderFull.

Returns a basic representation of the folder, with the updated shared link attached.

Remove shared link from folder

Removes a shared link from a folder.

This operation is performed by calling function RemoveSharedLinkFromFolder.

See the endpoint docs at API Reference.

Currently we don't have an example for calling RemoveSharedLinkFromFolder in integration tests

Arguments

  • folderId string
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0. Example: "12345"
  • requestBody RemoveSharedLinkFromFolderRequestBody
    • Request body of removeSharedLinkFromFolder method
  • queryParams RemoveSharedLinkFromFolderQueryParams
    • Query parameters of removeSharedLinkFromFolder method
  • headers RemoveSharedLinkFromFolderHeaders
    • Headers of removeSharedLinkFromFolder method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type FolderFull.

Returns a basic representation of a folder, with the shared link removed.