Package com.onshape.api.requests

Class DocumentsShareDocumentRequestEntries.Builder

java.lang.Object

com.onshape.api.requests.DocumentsShareDocumentRequestEntries.Builder

Enclosing class:

DocumentsShareDocumentRequestEntries

public static final class DocumentsShareDocumentRequestEntries.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
String	applicationId()	Get The ID of an Onshape Application to share with.
DocumentsShareDocumentRequestEntries.Builder	applicationId(String value)	Set The ID of an Onshape Application to share with.
DocumentsShareDocumentRequestEntries	build()
String	companyId()	Get The ID of an Onshape Company to share with
DocumentsShareDocumentRequestEntries.Builder	companyId(String value)	Set The ID of an Onshape Company to share with
String	email()	Get The email of a user to share with.
DocumentsShareDocumentRequestEntries.Builder	email(String value)	Set The email of a user to share with.
String	entryType()	Get The type of entity that whe are sharing with.
DocumentsShareDocumentRequestEntries.Builder	entryType(String value)	Set The type of entity that whe are sharing with.
String	teamId()	Get The ID of an Onshape Team to share with
DocumentsShareDocumentRequestEntries.Builder	teamId(String value)	Set The ID of an Onshape Team to share with
String	userId()	Get The ID of an Onshape User to share with
DocumentsShareDocumentRequestEntries.Builder	userId(String value)	Set The ID of an Onshape User to share with

Methods inherited from class java.lang.Object

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

Method Detail

companyId

public final String companyId()

Get The ID of an Onshape Company to share with

Returns:

The ID of an Onshape Company to share with

companyId

public final DocumentsShareDocumentRequestEntries.Builder companyId(String value)

Set The ID of an Onshape Company to share with

Parameters:

value - The ID of an Onshape Company to share with

Returns:

the Builder object.

email

public final String email()

Get The email of a user to share with. If the email is not associated with an existing Onshape user, an invite email will be sent to the email address if update=false, otherwise the response will be a NOT FOUND error.

Returns:

The email of a user to share with. If the email is not associated with an existing Onshape user, an invite email will be sent to the email address if update=false, otherwise the response will be a NOT FOUND error.

email

public final DocumentsShareDocumentRequestEntries.Builder email(String value)

Set The email of a user to share with. If the email is not associated with an existing Onshape user, an invite email will be sent to the email address if update=false, otherwise the response will be a NOT FOUND error.

Parameters:

value - The email of a user to share with. If the email is not associated with an existing Onshape user, an invite email will be sent to the email address if update=false, otherwise the response will be a NOT FOUND error.

Returns:

the Builder object.

teamId

public final String teamId()

Get The ID of an Onshape Team to share with

Returns:

The ID of an Onshape Team to share with

teamId

public final DocumentsShareDocumentRequestEntries.Builder teamId(String value)

Set The ID of an Onshape Team to share with

Parameters:

value - The ID of an Onshape Team to share with

Returns:

the Builder object.

userId

public final String userId()

Get The ID of an Onshape User to share with

Returns:

The ID of an Onshape User to share with

userId

public final DocumentsShareDocumentRequestEntries.Builder userId(String value)

Set The ID of an Onshape User to share with

Parameters:

value - The ID of an Onshape User to share with

Returns:

the Builder object.

applicationId

public final String applicationId()

Get The ID of an Onshape Application to share with. Note that application sharing only allows READ to be specified as a permission.

Returns:

The ID of an Onshape Application to share with. Note that application sharing only allows READ to be specified as a permission.

applicationId

public final DocumentsShareDocumentRequestEntries.Builder applicationId(String value)

Set The ID of an Onshape Application to share with. Note that application sharing only allows READ to be specified as a permission.

Parameters:

value - The ID of an Onshape Application to share with. Note that application sharing only allows READ to be specified as a permission.

Returns:

the Builder object.

entryType

public final String entryType()

Get The type of entity that whe are sharing with. Valid values are 0=User (specify userId or email), 1=Company, 2=Team, 4=Application. Must correspond to the id field populated.

Returns:

The type of entity that whe are sharing with. Valid values are 0=User (specify userId or email), 1=Company, 2=Team, 4=Application. Must correspond to the id field populated.

entryType

public final DocumentsShareDocumentRequestEntries.Builder entryType(String value)

Set The type of entity that whe are sharing with. Valid values are 0=User (specify userId or email), 1=Company, 2=Team, 4=Application. Must correspond to the id field populated.

Parameters:

value - The type of entity that whe are sharing with. Valid values are 0=User (specify userId or email), 1=Company, 2=Team, 4=Application. Must correspond to the id field populated.

Returns:

the Builder object.

build

public final DocumentsShareDocumentRequestEntries build()