Skip to content

Files

Latest commit

box-sdk-buildbox-sdk-build
feat: Support tests in Java (box/box-codegen#580) (#30)
Oct 23, 2024
9c867c8 · Oct 23, 2024

History

History
107 lines (67 loc) · 2.65 KB

trashedweblinks.md

File metadata and controls

107 lines (67 loc) · 2.65 KB

TrashedWebLinksManager

Restore web link

Restores a web link that has been moved to the trash.

An optional new parent ID can be provided to restore the web link to in case the original folder has been deleted.

This operation is performed by calling function restoreWeblinkFromTrash.

See the endpoint docs at API Reference.

client.getTrashedWebLinks().restoreWeblinkFromTrash(weblink.getId())

Arguments

  • webLinkId String
    • The ID of the web link. Example: "12345"
  • requestBody RestoreWeblinkFromTrashRequestBody
    • Request body of restoreWeblinkFromTrash method
  • queryParams RestoreWeblinkFromTrashQueryParams
    • Query parameters of restoreWeblinkFromTrash method
  • headers RestoreWeblinkFromTrashHeaders
    • Headers of restoreWeblinkFromTrash method

Returns

This function returns a value of type TrashWebLinkRestored.

Returns a web link object when it has been restored.

Get trashed web link

Retrieves a web link that has been moved to the trash.

This operation is performed by calling function getTrashedWebLinkById.

See the endpoint docs at API Reference.

client.getTrashedWebLinks().getTrashedWebLinkById(weblink.getId())

Arguments

  • webLinkId String
    • The ID of the web link. Example: "12345"
  • queryParams GetTrashedWebLinkByIdQueryParams
    • Query parameters of getTrashedWebLinkById method
  • headers GetTrashedWebLinkByIdHeaders
    • Headers of getTrashedWebLinkById method

Returns

This function returns a value of type TrashWebLink.

Returns the web link that was trashed, including information about when the it was moved to the trash.

Permanently remove web link

Permanently deletes a web link that is in the trash. This action cannot be undone.

This operation is performed by calling function deleteTrashedWebLinkById.

See the endpoint docs at API Reference.

client.getTrashedWebLinks().deleteTrashedWebLinkById(weblink.getId())

Arguments

  • webLinkId String
    • The ID of the web link. Example: "12345"
  • headers DeleteTrashedWebLinkByIdHeaders
    • Headers of deleteTrashedWebLinkById method

Returns

This function returns a value of type void.

Returns an empty response when the web link was permanently deleted.