Package com.onshape.api.responses

Class DocumentsShareDocumentResponseEntries

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.DocumentsShareDocumentResponseEntries

public final class DocumentsShareDocumentResponseEntries
extends AbstractResponseObject

Object used in calls to shareDocument API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	acceptOwnerTransfer	For internal use
String	email	The email of the user, if the entryType is USER.
String	entryId	The ID of the entity to which this entry corresponds
String	entryState	The state of user to which the share entry applies, if a user.
Number	entryType	The type of entity to which the share entry applies.
String	image	For internal use
String	name	The name of the entity that the object is shared with
String	objectId	The ID of the object
Boolean	pendingOwnerTransfer	For internal use
Number	permission	Obsolete
String[]	permissionSet	The permissions for the object that have been granted to the entity.

Constructor Summary

Constructors

Constructor	Description
DocumentsShareDocumentResponseEntries()

Method Summary

Modifier and Type	Method	Description
Boolean	getAcceptOwnerTransfer()	Get For internal use
String	getEmail()	Get The email of the user, if the entryType is USER.
String	getEntryId()	Get The ID of the entity to which this entry corresponds
String	getEntryState()	Get The state of user to which the share entry applies, if a user.
Number	getEntryType()	Get The type of entity to which the share entry applies.
String	getImage()	Get For internal use
String	getName()	Get The name of the entity that the object is shared with
String	getObjectId()	Get The ID of the object
Boolean	getPendingOwnerTransfer()	Get For internal use
Number	getPermission()	Get Obsolete
String[]	getPermissionSet()	Get The permissions for the object that have been granted to the entity.
String	toString()

Methods inherited from class com.onshape.api.types.AbstractResponseObject

getOtherProperties

Methods inherited from class java.lang.Object

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

Field Detail

objectId

public String objectId

The ID of the object

entryId

public String entryId

The ID of the entity to which this entry corresponds

entryType

public Number entryType

The type of entity to which the share entry applies. Possible values include 0=User, 1=Company, 2=Team, 3=<Reserved>, 4=Application

entryState

public String entryState

The state of user to which the share entry applies, if a user. Possible states include ACTIVE, INACTIVE, REQUESTED, APPROVED, DELETED, REQUEST_EXPIRED.

email

public String email

The email of the user, if the entryType is USER.

name

public String name

The name of the entity that the object is shared with

permissionSet

public String[] permissionSet

The permissions for the object that have been granted to the entity.

permission

public Number permission

Obsolete

image

public String image

For internal use

pendingOwnerTransfer

public Boolean pendingOwnerTransfer

For internal use

acceptOwnerTransfer

public Boolean acceptOwnerTransfer

For internal use

Constructor Detail

DocumentsShareDocumentResponseEntries

public DocumentsShareDocumentResponseEntries()

Method Detail

getObjectId

public final String getObjectId()

Get The ID of the object

Returns:

The ID of the object

getEntryId

public final String getEntryId()

Get The ID of the entity to which this entry corresponds

Returns:

The ID of the entity to which this entry corresponds

getEntryType

public final Number getEntryType()

Get The type of entity to which the share entry applies. Possible values include 0=User, 1=Company, 2=Team, 3=<Reserved>, 4=Application

Returns:

The type of entity to which the share entry applies. Possible values include 0=User, 1=Company, 2=Team, 3=<Reserved>, 4=Application

getEntryState

public final String getEntryState()

Get The state of user to which the share entry applies, if a user. Possible states include ACTIVE, INACTIVE, REQUESTED, APPROVED, DELETED, REQUEST_EXPIRED.

Returns:

The state of user to which the share entry applies, if a user. Possible states include ACTIVE, INACTIVE, REQUESTED, APPROVED, DELETED, REQUEST_EXPIRED.

getEmail

public final String getEmail()

Get The email of the user, if the entryType is USER.

Returns:

The email of the user, if the entryType is USER.

getName

public final String getName()

Get The name of the entity that the object is shared with

Returns:

The name of the entity that the object is shared with

getPermissionSet

public final String[] getPermissionSet()

Get The permissions for the object that have been granted to the entity.

Returns:

The permissions for the object that have been granted to the entity.

getPermission

public final Number getPermission()

Get Obsolete

Returns:

Obsolete

getImage

public final String getImage()

Get For internal use

Returns:

For internal use

getPendingOwnerTransfer

public final Boolean getPendingOwnerTransfer()

Get For internal use

Returns:

For internal use

getAcceptOwnerTransfer

public final Boolean getAcceptOwnerTransfer()

Get For internal use

Returns:

For internal use

toString

public String toString()

Overrides:

toString in class Object