Package com.onshape.api.requests

Class FoldersShareFolderRequest

java.lang.Object

com.onshape.api.requests.FoldersShareFolderRequest

public final class FoldersShareFolderRequest
extends Object

Request object for shareFolder API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FoldersShareFolderRequest.Builder

Method Summary

Modifier and Type	Method	Description
static FoldersShareFolderRequest.Builder	builder(Onshape onshape)
FoldersShareFolderRequestEntries[]	getEntries()	Get List of target entities to share with.
String	getFolderId()	Get The ID of the folder to be shared.
String	getMessage()	Get An optional message to include in the share email.
String[]	getPermissionSet()	Get The permissions to grant to the entities.
Boolean	getUpdate()	Get If true, indicates that the request is intended to be an update of existing share permissions for the entities in the entries list.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFolderId

public final String getFolderId()

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.

getEntries

public final FoldersShareFolderRequestEntries[] getEntries()

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

Returns:

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

getPermissionSet

public final String[] getPermissionSet()

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.

getUpdate

public final Boolean getUpdate()

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.

getMessage

public final String getMessage()

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.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final FoldersShareFolderRequest.Builder builder(Onshape onshape)