IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

CreateLink Method

Creates a shared link.

Syntax

box.createLink(resourceId, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method creates a shared link for the resource specified by ResourceId. The URL of the shared link is returned.

Only one shared link may be active at a time for each resource; calling this method for a resource that already has an active shared link will update the shared link's settings without changing its URL.

The following configuration settings may be used to configure the shared link:


// Create a password-protected shared link for the given file.
box.Config("CreateLinkPassword=password");
string sharingUrl = box.CreateLink("f:09876");

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]