com.dropbox.core.v2.sharing

Class GetSharedLinkMetadataBuilder

java.lang.Object

com.dropbox.core.v2.sharing.GetSharedLinkMetadataBuilder

public class GetSharedLinkMetadataBuilder
extends Object

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

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

Method Summary

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

IllegalArgumentException - If any argument does not meet its preconditions.

withLinkPassword

public GetSharedLinkMetadataBuilder withLinkPassword(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