com.dropbox.core.v2.sharing

Class CreateSharedLinkBuilder

java.lang.Object

com.dropbox.core.v2.sharing.CreateSharedLinkBuilder

public class CreateSharedLinkBuilder
extends Object

The request builder returned by DbxUserSharingRequests.createSharedLinkBuilder(java.lang.String).

Use this class to set optional request parameters and complete the request.

Method Summary

Modifier and Type	Method and Description
PathLinkMetadata	start() Issues the request.
CreateSharedLinkBuilder	withPendingUpload(PendingUploadMode pendingUpload) Set value for optional field.
CreateSharedLinkBuilder	withShortUrl(Boolean shortUrl) Set value for optional field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withShortUrl

public CreateSharedLinkBuilder withShortUrl(Boolean shortUrl)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

shortUrl - Whether to return a shortened URL. Defaults to false when set to null.

Returns:

this builder

withPendingUpload

public CreateSharedLinkBuilder withPendingUpload(PendingUploadMode pendingUpload)

Set value for optional field.

Parameters:

pendingUpload - If it's okay to share a path that does not yet exist, set this to either PendingUploadMode.FILE or PendingUploadMode.FOLDER to indicate whether to assume it's a file or folder.

Returns:

this builder

start

public PathLinkMetadata start()
                       throws CreateSharedLinkErrorException,
                              DbxException

Issues the request.

Throws:

CreateSharedLinkErrorException

DbxException