Package com.onshape.api.requests

Class FoldersUnShareRequest.Builder

java.lang.Object

com.onshape.api.requests.FoldersUnShareRequest.Builder

Enclosing class:

FoldersUnShareRequest

public static final class FoldersUnShareRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
FoldersUnShareResponse	call(OnshapeDocument document, String fid)	Calls unShare method, Remove share permissions from folder
FoldersUnShareResponse	call(String eid, String fid)	Calls unShare method, Remove share permissions from folder
Number	entryType()	Get The type of entity referenced by eid.
FoldersUnShareRequest.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 FoldersUnShareRequest.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 FoldersUnShareResponse call(String eid,
                                         String fid)
                                  throws OnshapeException

Calls unShare method, Remove share permissions from folder

Parameters:

eid - Entry ID of the share entry to be deleted

fid - Folder ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final FoldersUnShareResponse call(OnshapeDocument document,
                                         String fid)
                                  throws OnshapeException

Calls unShare method, Remove share permissions from folder

Parameters:

document - Document object from Onshape URL.

fid - Folder ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error