CreateLink Method

Creates a shared link.

Syntax

QString CreateLink(const QString& qsResourceId);

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:

• CreateLinkAccess
• CreateLinkAllowDownloads
• CreateLinkExpiration
• CreateLinkPassword

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

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.