Package com.onshape.api.responses

Class DocumentsGetAclResponse

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.DocumentsGetAclResponse

public final class DocumentsGetAclResponse
extends AbstractResponseObject

Response object for getAcl API endpoint. © 2018-Present Onshape Inc.

Constructor Summary

Constructors

Constructor	Description
DocumentsGetAclResponse()

Method Summary

Modifier and Type	Method	Description
DocumentsGetAclResponseEntries[]	getEntries()	Get The current share entries for the object.
String	getHref()	Get A URL referencing the API to get this structure
String	getId()	Get Not used
DocumentsGetAclResponseInheritedAcls[]	getInheritedAcls()	Get A list of parent objects from which this object inherits access rights.
Boolean	getIsAdmin()	Get True if the requesting user has RESHARE privileges on the object.
Boolean	getIsPublic()	Get True if the object is public
String	getName()	Get Not used
String	getObjectId()	Get The ID of the object
Number	getObjectType()	Get Set to the value 1, indicating the the objectId indicates a document, or 4, indicating that the objectId indicates a folder
DocumentsGetAclResponseOwner	getOwner()	Get Information about the object owner
Boolean	getSharedWithSupport()	Get True if the object is shared with support
String	getVisibility()	Get A description string indicating whether the object is public or private
DocumentsGetAclResponse	refresh(Onshape onshape)	Refresh this page of results
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

Constructor Detail

DocumentsGetAclResponse

public DocumentsGetAclResponse()

Method Detail

refresh

public final DocumentsGetAclResponse refresh(Onshape onshape)
                                      throws OnshapeException

Refresh this page of results

Parameters:

onshape - The Onshape client object.

Returns:

Updated response.

Throws:

OnshapeException - On HTTP or serialization error.

getIsPublic

public final Boolean getIsPublic()

Get True if the object is public

Returns:

True if the object is public

getIsAdmin

public final Boolean getIsAdmin()

Get True if the requesting user has RESHARE privileges on the object. If set to false, entries that do not relate to the caller are removed from the output.

Returns:

True if the requesting user has RESHARE privileges on the object. If set to false, entries that do not relate to the caller are removed from the output.

getSharedWithSupport

public final Boolean getSharedWithSupport()

Get True if the object is shared with support

Returns:

True if the object is shared with support

getVisibility

public final String getVisibility()

Get A description string indicating whether the object is public or private

Returns:

A description string indicating whether the object is public or private

getEntries

public final DocumentsGetAclResponseEntries[] getEntries()

Get The current share entries for the object. Each share entry indicates an entity that the object is shared with and the permissions granted to the entity

Returns:

The current share entries for the object. Each share entry indicates an entity that the object is shared with and the permissions granted to the entity

getObjectId

public final String getObjectId()

Get The ID of the object

Returns:

The ID of the object

getObjectType

public final Number getObjectType()

Get Set to the value 1, indicating the the objectId indicates a document, or 4, indicating that the objectId indicates a folder

Returns:

Set to the value 1, indicating the the objectId indicates a document, or 4, indicating that the objectId indicates a folder

getOwner

public final DocumentsGetAclResponseOwner getOwner()

Get Information about the object owner

Returns:

Information about the object 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

getInheritedAcls

public final DocumentsGetAclResponseInheritedAcls[] getInheritedAcls()

Get A list of parent objects from which this object inherits access rights. Parent objects are currently always folders

Returns:

A list of parent objects from which this object inherits access rights. Parent objects are currently always folders

toString

public String toString()

Overrides:

toString in class Object