Skip to content

SharedLinksWebLinks.md

Latest commit

 

History

History
176 lines (111 loc) · 5.68 KB

SharedLinksWebLinks.md

File metadata and controls

176 lines (111 loc) · 5.68 KB

SharedLinksWebLinksManager

Find web link for shared link

Returns the web link represented by a shared link.

A shared web link 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 web link when only given a shared link.

This operation is performed by calling function findWebLinkForSharedLink.

See the endpoint docs at API Reference.

try await userClient.sharedLinksWebLinks.findWebLinkForSharedLink(queryParams: FindWebLinkForSharedLinkQueryParams(), headers: FindWebLinkForSharedLinkHeaders(boxapi: "\("shared_link=")\(webLinkFromApi.sharedLink!.url)\("&shared_link_password=Secret123@")"))

Arguments

  • queryParams FindWebLinkForSharedLinkQueryParams
    • Query parameters of findWebLinkForSharedLink method
  • headers FindWebLinkForSharedLinkHeaders
    • Headers of findWebLinkForSharedLink method

Returns

This function returns a value of type WebLink.

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

Get shared link for web link

Gets the information for a shared link on a web link.

This operation is performed by calling function getSharedLinkForWebLink.

See the endpoint docs at API Reference.

try await client.sharedLinksWebLinks.getSharedLinkForWebLink(webLinkId: webLinkId, queryParams: GetSharedLinkForWebLinkQueryParams(fields: "shared_link"))

Arguments

  • webLinkId String
    • The ID of the web link. Example: "12345"
  • queryParams GetSharedLinkForWebLinkQueryParams
    • Query parameters of getSharedLinkForWebLink method
  • headers GetSharedLinkForWebLinkHeaders
    • Headers of getSharedLinkForWebLink method

Returns

This function returns a value of type WebLink.

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

Add shared link to web link

Adds a shared link to a web link.

This operation is performed by calling function addShareLinkToWebLink.

See the endpoint docs at API Reference.

try await client.sharedLinksWebLinks.addShareLinkToWebLink(webLinkId: webLinkId, requestBody: AddShareLinkToWebLinkRequestBody(sharedLink: AddShareLinkToWebLinkRequestBodySharedLinkField(access: AddShareLinkToWebLinkRequestBodySharedLinkAccessField.open, password: "Secret123@")), queryParams: AddShareLinkToWebLinkQueryParams(fields: "shared_link"))

Arguments

  • webLinkId String
    • The ID of the web link. Example: "12345"
  • requestBody AddShareLinkToWebLinkRequestBody
    • Request body of addShareLinkToWebLink method
  • queryParams AddShareLinkToWebLinkQueryParams
    • Query parameters of addShareLinkToWebLink method
  • headers AddShareLinkToWebLinkHeaders
    • Headers of addShareLinkToWebLink method

Returns

This function returns a value of type WebLink.

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

Update shared link on web link

Updates a shared link on a web link.

This operation is performed by calling function updateSharedLinkOnWebLink.

See the endpoint docs at API Reference.

try await client.sharedLinksWebLinks.updateSharedLinkOnWebLink(webLinkId: webLinkId, requestBody: UpdateSharedLinkOnWebLinkRequestBody(sharedLink: UpdateSharedLinkOnWebLinkRequestBodySharedLinkField(access: UpdateSharedLinkOnWebLinkRequestBodySharedLinkAccessField.collaborators)), queryParams: UpdateSharedLinkOnWebLinkQueryParams(fields: "shared_link"))

Arguments

  • webLinkId String
    • The ID of the web link. Example: "12345"
  • requestBody UpdateSharedLinkOnWebLinkRequestBody
    • Request body of updateSharedLinkOnWebLink method
  • queryParams UpdateSharedLinkOnWebLinkQueryParams
    • Query parameters of updateSharedLinkOnWebLink method
  • headers UpdateSharedLinkOnWebLinkHeaders
    • Headers of updateSharedLinkOnWebLink method

Returns

This function returns a value of type WebLink.

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

Remove shared link from web link

Removes a shared link from a web link.

This operation is performed by calling function removeSharedLinkFromWebLink.

See the endpoint docs at API Reference.

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

Arguments

  • webLinkId String
    • The ID of the web link. Example: "12345"
  • requestBody RemoveSharedLinkFromWebLinkRequestBody
    • Request body of removeSharedLinkFromWebLink method
  • queryParams RemoveSharedLinkFromWebLinkQueryParams
    • Query parameters of removeSharedLinkFromWebLink method
  • headers RemoveSharedLinkFromWebLinkHeaders
    • Headers of removeSharedLinkFromWebLink method

Returns

This function returns a value of type WebLink.

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