Package com.onshape.api.responses

Class DocumentsGetDocumentsResponse

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.DocumentsGetDocumentsResponse

public final class DocumentsGetDocumentsResponse
extends AbstractResponseObject

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

Constructor Summary

Constructors

Constructor	Description
DocumentsGetDocumentsResponse()

Method Summary

Modifier and Type	Method	Description
String	getHref()	Get URL of current page of results
DocumentsGetDocumentsResponseItems[]	getItems()	Get Array of documents
String	getNext()	Get URL of next page of results
String	getPrevious()	Get URL of previous page of results
DocumentsGetDocumentsResponse	next(Onshape onshape)	Fetch next page of results
DocumentsGetDocumentsResponse	previous(Onshape onshape)	Fetch previous page of results
DocumentsGetDocumentsResponse	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

DocumentsGetDocumentsResponse

public DocumentsGetDocumentsResponse()

Method Detail

next

public final DocumentsGetDocumentsResponse next(Onshape onshape)
                                         throws OnshapeException

Fetch next page of results

Parameters:

onshape - The Onshape client object.

Returns:

Next page of results or null if this is last page.

Throws:

OnshapeException - On HTTP or serialization error.

previous

public final DocumentsGetDocumentsResponse previous(Onshape onshape)
                                             throws OnshapeException

Fetch previous page of results

Parameters:

onshape - The Onshape client object.

Returns:

Previous page of results or null if this is first page.

Throws:

OnshapeException - On HTTP or serialization error.

refresh

public final DocumentsGetDocumentsResponse 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.

getPrevious

public final String getPrevious()

Get URL of previous page of results

Returns:

URL of previous page of results

getHref

public final String getHref()

Get URL of current page of results

Returns:

URL of current page of results

getNext

public final String getNext()

Get URL of next page of results

Returns:

URL of next page of results

getItems

public final DocumentsGetDocumentsResponseItems[] getItems()

Get Array of documents

Returns:

Array of documents

toString

public String toString()

Overrides:

toString in class Object