Package com.onshape.api.requests

Class DocumentsShareDocumentRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsShareDocumentRequest.Builder

Enclosing class:

DocumentsShareDocumentRequest

public static final class DocumentsShareDocumentRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsShareDocumentResponse	call(OnshapeDocument document)	Calls shareDocument method, Share document with one or more entities, which may be users, companies, teams or applications.
DocumentsShareDocumentResponse	call(String did)	Calls shareDocument method, Share document with one or more entities, which may be users, companies, teams or applications.
String	documentId()	Get The ID of the document to be shared.
DocumentsShareDocumentRequest.Builder	documentId(String value)	Set The ID of the document to be shared.
String	elementId()	Get The ID of an element within the document to share.
DocumentsShareDocumentRequest.Builder	elementId(String value)	Set The ID of an element within the document to share.
DocumentsShareDocumentRequestEntries[]	entries()	Get List of target entities to share with.
DocumentsShareDocumentRequest.Builder	entries(DocumentsShareDocumentRequestEntries[] value)	Set List of target entities to share with.
String	message()	Get An optional message to include in the share email.
DocumentsShareDocumentRequest.Builder	message(String value)	Set An optional message to include in the share email.
String[]	permissionSet()	Get The permissions to grant to the entities.
DocumentsShareDocumentRequest.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.
DocumentsShareDocumentRequest.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.
String	workspaceId()	Get The ID of a workspace for use as the scope of sharing.
DocumentsShareDocumentRequest.Builder	workspaceId(String value)	Set The ID of a workspace for use as the scope of sharing.

Methods inherited from class java.lang.Object

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

Method Detail

documentId

public final String documentId()

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.

documentId

public final DocumentsShareDocumentRequest.Builder documentId(String value)

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

Parameters:

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

Returns:

the Builder object.

workspaceId

public final String workspaceId()

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.

workspaceId

public final DocumentsShareDocumentRequest.Builder workspaceId(String value)

Set 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.

Parameters:

value - 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 Builder object.

elementId

public final String elementId()

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.

elementId

public final DocumentsShareDocumentRequest.Builder elementId(String value)

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

Parameters:

value - 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 Builder object.

entries

public final DocumentsShareDocumentRequestEntries[] 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 DocumentsShareDocumentRequest.Builder entries(DocumentsShareDocumentRequestEntries[] 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 DocumentsShareDocumentRequest.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 DocumentsShareDocumentRequest.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 DocumentsShareDocumentRequest.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 DocumentsShareDocumentResponse call(String did)
                                          throws OnshapeException

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

Parameters:

did - Document ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final DocumentsShareDocumentResponse call(OnshapeDocument document)
                                          throws OnshapeException

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

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error