Package com.onshape.api.requests

Class ThumbnailsGetElementThumbnailWithApiConfigurationRequest.Builder

java.lang.Object

com.onshape.api.requests.ThumbnailsGetElementThumbnailWithApiConfigurationRequest.Builder

Enclosing class:

ThumbnailsGetElementThumbnailWithApiConfigurationRequest

public static final class ThumbnailsGetElementThumbnailWithApiConfigurationRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ThumbnailsGetElementThumbnailWithApiConfigurationResponse	call(OnshapeDocument document, String cid, String sz, Boolean rejectEmpty, Boolean requireConfigMatch)	Calls getElementThumbnailWithApiConfiguration method, Return thumbnail for element, with specified size in pixels
ThumbnailsGetElementThumbnailWithApiConfigurationResponse	call(String cid, String sz, String did, String wid, String eid, Boolean rejectEmpty, Boolean requireConfigMatch)	Calls getElementThumbnailWithApiConfiguration method, Return thumbnail for element, with specified size in pixels

Methods inherited from class java.lang.Object

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

Method Detail

call

public final ThumbnailsGetElementThumbnailWithApiConfigurationResponse call(String cid,
                                                                            String sz,
                                                                            String did,
                                                                            String wid,
                                                                            String eid,
                                                                            Boolean rejectEmpty,
                                                                            Boolean requireConfigMatch)
                                                                     throws OnshapeException

Calls getElementThumbnailWithApiConfiguration method, Return thumbnail for element, with specified size in pixels

Parameters:

cid - The api key for the given configuration

sz - Requested thumbnail size, such as 300x300

did - Document ID

wid - Workspace ID

eid - Element ID

rejectEmpty - If true, a 404 will be returned for thumbnails that are made for empty elements. Clients can use this parameter to skip the display of empty thumbnails and display a default icon instead. Defaults to false. (Default: null)

requireConfigMatch - If true, the thumbnail returned must match the exact configuration specified. If false, the thumbnail for the default configuration will be returned if the exact configuration is not found. Defaults to false (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final ThumbnailsGetElementThumbnailWithApiConfigurationResponse call(OnshapeDocument document,
                                                                            String cid,
                                                                            String sz,
                                                                            Boolean rejectEmpty,
                                                                            Boolean requireConfigMatch)
                                                                     throws OnshapeException

Calls getElementThumbnailWithApiConfiguration method, Return thumbnail for element, with specified size in pixels

Parameters:

document - Document object from Onshape URL.

cid - The api key for the given configuration

sz - Requested thumbnail size, such as 300x300

rejectEmpty - If true, a 404 will be returned for thumbnails that are made for empty elements. Clients can use this parameter to skip the display of empty thumbnails and display a default icon instead. Defaults to false. (Default: null)

requireConfigMatch - If true, the thumbnail returned must match the exact configuration specified. If false, the thumbnail for the default configuration will be returned if the exact configuration is not found. Defaults to false (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error