Package com.onshape.api.requests

Class FoldersShareFolderRequest.Builder

java.lang.Object

com.onshape.api.requests.FoldersShareFolderRequest.Builder

Enclosing class:

FoldersShareFolderRequest

public static final class FoldersShareFolderRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
FoldersShareFolderResponse	call(String fid)	Calls shareFolder method, Share folder with one or more entities, which may be users, companies, teams or applications.
FoldersShareFolderRequestEntries[]	entries()	Get List of target entities to share with.
FoldersShareFolderRequest.Builder	entries(FoldersShareFolderRequestEntries[] value)	Set List of target entities to share with.
String	folderId()	Get The ID of the folder to be shared.
FoldersShareFolderRequest.Builder	folderId(String value)	Set The ID of the folder to be shared.
String	message()	Get An optional message to include in the share email.
FoldersShareFolderRequest.Builder	message(String value)	Set An optional message to include in the share email.
String[]	permissionSet()	Get The permissions to grant to the entities.
FoldersShareFolderRequest.Builder	permissionSet(String[] value)	Set The permissions to grant to the entities.
Boolean	update()	Get If true, indicates that the request is intended to be an update of existing share permissions for the entities in the entries list.
FoldersShareFolderRequest.Builder	update(Boolean value)	Set If true, indicates that the request is intended to be an update of existing share permissions for the entities in the entries list.

Methods inherited from class java.lang.Object

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

Method Detail

folderId

public final String folderId()

Get The ID of the folder to be shared. Must match the folder ID specified in the URL.

Returns:

The ID of the folder to be shared. Must match the folder ID specified in the URL.

folderId

public final FoldersShareFolderRequest.Builder folderId(String value)

Set The ID of the folder to be shared. Must match the folder ID specified in the URL.

Parameters:

value - The ID of the folder to be shared. Must match the folder ID specified in the URL.

Returns:

the Builder object.

entries

public final FoldersShareFolderRequestEntries[] entries()

Get List of target entities to share with. Must not be empty.

Returns:

List of target entities to share with. Must not be empty.

entries

public final FoldersShareFolderRequest.Builder entries(FoldersShareFolderRequestEntries[] value)

Set List of target entities to share with. Must not be empty.

Parameters:

value - List of target entities to share with. Must not be empty.

Returns:

the Builder object.

permissionSet

public final String[] permissionSet()

Get The permissions to grant to the entities. Must not be empty. The valid permissions are READ, WRITE, DELETE, RESHARE, COMMENT, LINK, COPY, OWNER. It is an error for a permission set to be specified that is identical to the current permissions for an entity in the entries list.

Returns:

The permissions to grant to the entities. Must not be empty. The valid permissions are READ, WRITE, DELETE, RESHARE, COMMENT, LINK, COPY, OWNER. It is an error for a permission set to be specified that is identical to the current permissions for an entity in the entries list.

permissionSet

public final FoldersShareFolderRequest.Builder permissionSet(String[] value)

Set The permissions to grant to the entities. Must not be empty. The valid permissions are READ, WRITE, DELETE, RESHARE, COMMENT, LINK, COPY, OWNER. It is an error for a permission set to be specified that is identical to the current permissions for an entity in the entries list.

Parameters:

value - The permissions to grant to the entities. Must not be empty. The valid permissions are READ, WRITE, DELETE, RESHARE, COMMENT, LINK, COPY, OWNER. It is an error for a permission set to be specified that is identical to the current permissions for an entity in the entries list.

Returns:

the Builder object.

update

public final Boolean update()

Get If true, indicates that the request is intended to be an update of existing share permissions for the entities in the entries list.

Returns:

If true, indicates that the request is intended to be an update of existing share permissions for the entities in the entries list.

update

public final FoldersShareFolderRequest.Builder update(Boolean value)

Set If true, indicates that the request is intended to be an update of existing share permissions for the entities in the entries list.

Parameters:

value - If true, indicates that the request is intended to be an update of existing share permissions for the entities in the entries list.

Returns:

the Builder object.

message

public final String message()

Get An optional message to include in the share email. This message has a maximum allowed size.

Returns:

An optional message to include in the share email. This message has a maximum allowed size.

message

public final FoldersShareFolderRequest.Builder message(String value)

Set An optional message to include in the share email. This message has a maximum allowed size.

Parameters:

value - An optional message to include in the share email. This message has a maximum allowed size.

Returns:

the Builder object.

call

public final FoldersShareFolderResponse call(String fid)
                                      throws OnshapeException

Calls shareFolder method, Share folder with one or more entities, which may be users, companies, teams or applications.

Parameters:

fid - Folder ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error