Package com.dropbox.core.v2.sharing

Class DbxUserGetSharedLinkMetadataBuilder

java.lang.Object

com.dropbox.core.v2.sharing.DbxUserGetSharedLinkMetadataBuilder

public class DbxUserGetSharedLinkMetadataBuilder
extends java.lang.Object

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

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

Method Summary

Modifier and Type	Method	Description
SharedLinkMetadata	start()	Issues the request.
DbxUserGetSharedLinkMetadataBuilder	withLinkPassword(java.lang.String linkPassword)	Set value for optional field.
DbxUserGetSharedLinkMetadataBuilder	withPath(java.lang.String path)	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

withPath

public DbxUserGetSharedLinkMetadataBuilder withPath(java.lang.String path)

Set value for optional field.

Parameters:

path - If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used. Must match pattern "/(.|[\\r\\n])*".

Returns:

this builder

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

withLinkPassword

public DbxUserGetSharedLinkMetadataBuilder withLinkPassword(java.lang.String linkPassword)

Set value for optional field.

Parameters:

linkPassword - If the shared link has a password, this parameter can be used.

Returns:

this builder

start

public SharedLinkMetadata start()
                         throws SharedLinkErrorException,
                                DbxException

Issues the request.

Throws:

SharedLinkErrorException

DbxException