Package com.onshape.api.requests

Class DocumentsShareDocumentRequest

java.lang.Object

com.onshape.api.requests.DocumentsShareDocumentRequest

public final class DocumentsShareDocumentRequest
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentsShareDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentsShareDocumentRequest.Builder	builder(Onshape onshape)
String	getDocumentId()	Get The ID of the document to be shared.
String	getElementId()	Get The ID of an element within the document to share.
DocumentsShareDocumentRequestEntries[]	getEntries()	Get List of target entities to share with.
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	getWorkspaceId()	Get The ID of a workspace for use as the scope of sharing.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getDocumentId

public final String getDocumentId()

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

Returns:

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

getWorkspaceId

public final String getWorkspaceId()

Get The ID of a workspace for use as the scope of sharing. Used only to form URLs in a share email to the share recipient.

Returns:

The ID of a workspace for use as the scope of sharing. Used only to form URLs in a share email to the share recipient.

getElementId

public final String getElementId()

Get The ID of an element within the document to share. Used only to form URLs in a share email to the share recipient.

Returns:

The ID of an element within the document to share. Used only to form URLs in a share email to the share recipient.

getEntries

public final DocumentsShareDocumentRequestEntries[] 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 DocumentsShareDocumentRequest.Builder builder(Onshape onshape)