Package com.onshape.api.requests

Class DocumentsUnShareRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsUnShareRequest.Builder

Enclosing class:

DocumentsUnShareRequest

public static final class DocumentsUnShareRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsUnShareResponse	call(OnshapeDocument document)	Calls unShare method, Remove share permissions from document
DocumentsUnShareResponse	call(String eid, String did)	Calls unShare method, Remove share permissions from document
Number	entryType()	Get The type of entity referenced by eid.
DocumentsUnShareRequest.Builder	entryType(Number value)	Set The type of entity referenced by eid.

Methods inherited from class java.lang.Object

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

Method Detail

entryType

public final Number entryType()

Get The type of entity referenced by eid. Valid values are 0=User, 1=Company, 2=Team, 4=Application.

Returns:

The type of entity referenced by eid. Valid values are 0=User, 1=Company, 2=Team, 4=Application.

entryType

public final DocumentsUnShareRequest.Builder entryType(Number value)

Set The type of entity referenced by eid. Valid values are 0=User, 1=Company, 2=Team, 4=Application.

Parameters:

value - The type of entity referenced by eid. Valid values are 0=User, 1=Company, 2=Team, 4=Application.

Returns:

the Builder object.

call

public final DocumentsUnShareResponse call(String eid,
                                           String did)
                                    throws OnshapeException

Calls unShare method, Remove share permissions from document

Parameters:

eid - Entry ID of the share entry to be deleted

did - Document ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final DocumentsUnShareResponse call(OnshapeDocument document)
                                    throws OnshapeException

Calls unShare method, Remove share permissions from document

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error