Package com.onshape.api.responses

Class DocumentsShareDocumentResponseInheritedAcls

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.DocumentsShareDocumentResponseInheritedAcls

public final class DocumentsShareDocumentResponseInheritedAcls
extends AbstractResponseObject

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

Field Summary

Fields

Modifier and Type	Field	Description
DocumentsShareDocumentResponseInheritedAclsEntries[]	entries	The current share entries for the parent folder.
String	href	A URL referencing the API to get this structure
String	id	Not used
String	name	Not used
String	objectId	The ID of the parent folder that contributes access rights
Number	objectName	The name of the parent object
Number	objectType	Set to the value 4, indicating the the objectId identifies a folder
DocumentsShareDocumentResponseInheritedAclsOwner	owner	Information about the document owner
String	visibility	A description string indicating whether the folder is public or private.

Constructor Summary

Constructors

Constructor	Description
DocumentsShareDocumentResponseInheritedAcls()

Method Summary

Modifier and Type	Method	Description
DocumentsShareDocumentResponseInheritedAclsEntries[]	getEntries()	Get The current share entries for the parent folder.
String	getHref()	Get A URL referencing the API to get this structure
String	getId()	Get Not used
String	getName()	Get Not used
String	getObjectId()	Get The ID of the parent folder that contributes access rights
Number	getObjectName()	Get The name of the parent object
Number	getObjectType()	Get Set to the value 4, indicating the the objectId identifies a folder
DocumentsShareDocumentResponseInheritedAclsOwner	getOwner()	Get Information about the document owner
String	getVisibility()	Get A description string indicating whether the folder is public or private.
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 parent folder that contributes access rights

objectType

public Number objectType

Set to the value 4, indicating the the objectId identifies a folder

objectName

public Number objectName

The name of the parent object

visibility

public String visibility

A description string indicating whether the folder is public or private. Currently always private

entries

public DocumentsShareDocumentResponseInheritedAclsEntries[] entries

The current share entries for the parent folder. Each share entry indicates an entity that the folder and contained objects are shared with and the permissions granted to the entity

owner

public DocumentsShareDocumentResponseInheritedAclsOwner owner

Information about the document owner

id

public String id

Not used

name

public String name

Not used

href

public String href

A URL referencing the API to get this structure

Constructor Detail

DocumentsShareDocumentResponseInheritedAcls

public DocumentsShareDocumentResponseInheritedAcls()

Method Detail

getObjectId

public final String getObjectId()

Get The ID of the parent folder that contributes access rights

Returns:

The ID of the parent folder that contributes access rights

getObjectType

public final Number getObjectType()

Get Set to the value 4, indicating the the objectId identifies a folder

Returns:

Set to the value 4, indicating the the objectId identifies a folder

getObjectName

public final Number getObjectName()

Get The name of the parent object

Returns:

The name of the parent object

getVisibility

public final String getVisibility()

Get A description string indicating whether the folder is public or private. Currently always private

Returns:

A description string indicating whether the folder is public or private. Currently always private

getEntries

public final DocumentsShareDocumentResponseInheritedAclsEntries[] getEntries()

Get The current share entries for the parent folder. Each share entry indicates an entity that the folder and contained objects are shared with and the permissions granted to the entity

Returns:

The current share entries for the parent folder. Each share entry indicates an entity that the folder and contained objects are shared with and the permissions granted to the entity

getOwner

public final DocumentsShareDocumentResponseInheritedAclsOwner getOwner()

Get Information about the document owner

Returns:

Information about the document owner

getId

public final String getId()

Get Not used

Returns:

Not used

getName

public final String getName()

Get Not used

Returns:

Not used

getHref

public final String getHref()

Get A URL referencing the API to get this structure

Returns:

A URL referencing the API to get this structure

toString

public String toString()

Overrides:

toString in class Object