com.dropbox.core.v2.sharing

Class SharedFileMetadata.Builder

java.lang.Object

com.dropbox.core.v2.sharing.SharedFileMetadata.Builder

Enclosing class:

SharedFileMetadata

public static class SharedFileMetadata.Builder
extends java.lang.Object

Builder for SharedFileMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessLevel	accessType
protected ExpectedSharedContentLinkMetadata	expectedLinkMetadata
protected java.lang.String	id
protected SharedContentLinkMetadata	linkMetadata
protected java.lang.String	name
protected java.util.List<java.lang.String>	ownerDisplayNames
protected Team	ownerTeam
protected java.lang.String	parentSharedFolderId
protected java.lang.String	pathDisplay
protected java.lang.String	pathLower
protected java.util.List<FilePermission>	permissions
protected FolderPolicy	policy
protected java.lang.String	previewUrl
protected java.util.Date	timeInvited

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(java.lang.String id, java.lang.String name, FolderPolicy policy, java.lang.String previewUrl)

Method Summary

Modifier and Type	Method and Description
SharedFileMetadata	build() Builds an instance of SharedFileMetadata configured with this builder's values
SharedFileMetadata.Builder	withAccessType(AccessLevel accessType) Set value for optional field.
SharedFileMetadata.Builder	withExpectedLinkMetadata(ExpectedSharedContentLinkMetadata expectedLinkMetadata) Set value for optional field.
SharedFileMetadata.Builder	withLinkMetadata(SharedContentLinkMetadata linkMetadata) Set value for optional field.
SharedFileMetadata.Builder	withOwnerDisplayNames(java.util.List<java.lang.String> ownerDisplayNames) Set value for optional field.
SharedFileMetadata.Builder	withOwnerTeam(Team ownerTeam) Set value for optional field.
SharedFileMetadata.Builder	withParentSharedFolderId(java.lang.String parentSharedFolderId) Set value for optional field.
SharedFileMetadata.Builder	withPathDisplay(java.lang.String pathDisplay) Set value for optional field.
SharedFileMetadata.Builder	withPathLower(java.lang.String pathLower) Set value for optional field.
SharedFileMetadata.Builder	withPermissions(java.util.List<FilePermission> permissions) Set value for optional field.
SharedFileMetadata.Builder	withTimeInvited(java.util.Date timeInvited) Set value for optional field.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final java.lang.String id

name

protected final java.lang.String name

policy

protected final FolderPolicy policy

previewUrl

protected final java.lang.String previewUrl

accessType

protected AccessLevel accessType

expectedLinkMetadata

protected ExpectedSharedContentLinkMetadata expectedLinkMetadata

linkMetadata

protected SharedContentLinkMetadata linkMetadata

ownerDisplayNames

protected java.util.List<java.lang.String> ownerDisplayNames

ownerTeam

protected Team ownerTeam

parentSharedFolderId

protected java.lang.String parentSharedFolderId

pathDisplay

protected java.lang.String pathDisplay

pathLower

protected java.lang.String pathLower

permissions

protected java.util.List<FilePermission> permissions

timeInvited

protected java.util.Date timeInvited

Constructor Detail

Builder

protected Builder(java.lang.String id,
                  java.lang.String name,
                  FolderPolicy policy,
                  java.lang.String previewUrl)

Method Detail

withAccessType

public SharedFileMetadata.Builder withAccessType(AccessLevel accessType)

Set value for optional field.

Parameters:

accessType - The current user's access level for this shared file.

Returns:

this builder

withExpectedLinkMetadata

public SharedFileMetadata.Builder withExpectedLinkMetadata(ExpectedSharedContentLinkMetadata expectedLinkMetadata)

Set value for optional field.

Parameters:

expectedLinkMetadata - The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.

Returns:

this builder

withLinkMetadata

public SharedFileMetadata.Builder withLinkMetadata(SharedContentLinkMetadata linkMetadata)

Set value for optional field.

Parameters:

linkMetadata - The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.

Returns:

this builder

withOwnerDisplayNames

public SharedFileMetadata.Builder withOwnerDisplayNames(java.util.List<java.lang.String> ownerDisplayNames)

Set value for optional field.

Parameters:

ownerDisplayNames - The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. Must not contain a null item.

Returns:

this builder

Throws:

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

withOwnerTeam

public SharedFileMetadata.Builder withOwnerTeam(Team ownerTeam)

Set value for optional field.

Parameters:

ownerTeam - The team that owns the file. This field is not present if the file is not owned by a team.

Returns:

this builder

withParentSharedFolderId

public SharedFileMetadata.Builder withParentSharedFolderId(java.lang.String parentSharedFolderId)

Set value for optional field.

Parameters:

parentSharedFolderId - The ID of the parent shared folder. This field is present only if the file is contained within a shared folder. Must match pattern "[-_0-9a-zA-Z:]+".

Returns:

this builder

Throws:

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

withPathDisplay

public SharedFileMetadata.Builder withPathDisplay(java.lang.String pathDisplay)

Set value for optional field.

Parameters:

pathDisplay - The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.

Returns:

this builder

withPathLower

public SharedFileMetadata.Builder withPathLower(java.lang.String pathLower)

Set value for optional field.

Parameters:

pathLower - The lower-case full path of this file. Absent for unmounted files.

Returns:

this builder

withPermissions

public SharedFileMetadata.Builder withPermissions(java.util.List<FilePermission> permissions)

Set value for optional field.

Parameters:

permissions - The sharing permissions that requesting user has on this file. This corresponds to the entries given in the actions argument to DbxUserSharingRequests.getFileMetadataBatch(List,List) or the actions argument to DbxUserSharingRequests.getFileMetadata(String,List). Must not contain a null item.

Returns:

this builder

Throws:

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

withTimeInvited

public SharedFileMetadata.Builder withTimeInvited(java.util.Date timeInvited)

Set value for optional field.

Parameters:

timeInvited - Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

Returns:

this builder

build

public SharedFileMetadata build()

Builds an instance of SharedFileMetadata configured with this builder's values

Returns:

new instance of SharedFileMetadata