Class ThumbnailApi

Hierarchy

BaseAPI
- ThumbnailApi

Constructors

constructor

new ThumbnailApi(configuration?: Configuration): ThumbnailApi
Parameters
- configuration: Configuration = DefaultConfig
Returns ThumbnailApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteApplicationThumbnails

deleteApplicationThumbnails(requestParameters: DeleteApplicationThumbnailsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete application tab thumbnail by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: DeleteApplicationThumbnailsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ThumbnailApi.ts:164

deleteApplicationThumbnailsRaw

deleteApplicationThumbnailsRaw(requestParameters: DeleteApplicationThumbnailsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete application tab thumbnail by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: DeleteApplicationThumbnailsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ThumbnailApi.ts:118

getDocumentThumbnail

getDocumentThumbnail(requestParameters: GetDocumentThumbnailRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTThumbnailInfo>
Parameters
- requestParameters: GetDocumentThumbnailRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTThumbnailInfo>
- Defined in apis/ThumbnailApi.ts:204

getDocumentThumbnailRaw

getDocumentThumbnailRaw(requestParameters: GetDocumentThumbnailRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTThumbnailInfo>>
Parameters
- requestParameters: GetDocumentThumbnailRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTThumbnailInfo>>
- Defined in apis/ThumbnailApi.ts:171

getDocumentThumbnailWithSize

getDocumentThumbnailWithSize(requestParameters: GetDocumentThumbnailWithSizeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Retrieve thumbnail information for a document, with a specified size in pixels by document ID and workspace ID.
Parameters
- requestParameters: GetDocumentThumbnailWithSizeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ThumbnailApi.ts:258

getDocumentThumbnailWithSizeRaw

getDocumentThumbnailWithSizeRaw(requestParameters: GetDocumentThumbnailWithSizeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Retrieve thumbnail information for a document, with a specified size in pixels by document ID and workspace ID.
Parameters
- requestParameters: GetDocumentThumbnailWithSizeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ThumbnailApi.ts:212

getElementThumbnail

getElementThumbnail(requestParameters: GetElementThumbnailRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTThumbnailInfo>
Retrieve thumbnail information for a tab by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: GetElementThumbnailRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTThumbnailInfo>
- Defined in apis/ThumbnailApi.ts:312

getElementThumbnailRaw

getElementThumbnailRaw(requestParameters: GetElementThumbnailRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTThumbnailInfo>>
Retrieve thumbnail information for a tab by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: GetElementThumbnailRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTThumbnailInfo>>
- Defined in apis/ThumbnailApi.ts:266

getElementThumbnailWithApiConfiguration

getElementThumbnailWithApiConfiguration(requestParameters: GetElementThumbnailWithApiConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Retrieve thumbnail information for a tab, with a specified size in pixels by document ID, workspace ID, tab ID, and configuration ID.
Parameters
- requestParameters: GetElementThumbnailWithApiConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ThumbnailApi.ts:382

getElementThumbnailWithApiConfigurationRaw

getElementThumbnailWithApiConfigurationRaw(requestParameters: GetElementThumbnailWithApiConfigurationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Retrieve thumbnail information for a tab, with a specified size in pixels by document ID, workspace ID, tab ID, and configuration ID.
Parameters
- requestParameters: GetElementThumbnailWithApiConfigurationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ThumbnailApi.ts:320

getElementThumbnailWithSize

getElementThumbnailWithSize(requestParameters: GetElementThumbnailWithSizeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Retrieve thumbnail information for a tab, with a specified size in pixels by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: GetElementThumbnailWithSizeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ThumbnailApi.ts:452

getElementThumbnailWithSizeRaw

getElementThumbnailWithSizeRaw(requestParameters: GetElementThumbnailWithSizeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Retrieve thumbnail information for a tab, with a specified size in pixels by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: GetElementThumbnailWithSizeRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ThumbnailApi.ts:390

getThumbnailForDocument

getThumbnailForDocument(requestParameters: GetThumbnailForDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTThumbnailInfo>
Retrieve thumbnail information for document in default workspace by document ID.
Parameters
- requestParameters: GetThumbnailForDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTThumbnailInfo>
- Defined in apis/ThumbnailApi.ts:490

getThumbnailForDocumentAndVersion

getThumbnailForDocumentAndVersion(requestParameters: GetThumbnailForDocumentAndVersionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTThumbnailInfo>
Parameters
- requestParameters: GetThumbnailForDocumentAndVersionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTThumbnailInfo>
- Defined in apis/ThumbnailApi.ts:534

getThumbnailForDocumentAndVersionOld

getThumbnailForDocumentAndVersionOld(requestParameters: GetThumbnailForDocumentAndVersionOldRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTThumbnailInfo>
Retrieve thumbnail information for a document at a specified version by document ID and version ID.
Parameters
- requestParameters: GetThumbnailForDocumentAndVersionOldRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTThumbnailInfo>
- Defined in apis/ThumbnailApi.ts:576

getThumbnailForDocumentAndVersionOldRaw

getThumbnailForDocumentAndVersionOldRaw(requestParameters: GetThumbnailForDocumentAndVersionOldRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTThumbnailInfo>>
Retrieve thumbnail information for a document at a specified version by document ID and version ID.
Parameters
- requestParameters: GetThumbnailForDocumentAndVersionOldRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTThumbnailInfo>>
- Defined in apis/ThumbnailApi.ts:542

getThumbnailForDocumentAndVersionRaw

getThumbnailForDocumentAndVersionRaw(requestParameters: GetThumbnailForDocumentAndVersionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTThumbnailInfo>>
Parameters
- requestParameters: GetThumbnailForDocumentAndVersionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTThumbnailInfo>>
- Defined in apis/ThumbnailApi.ts:497

getThumbnailForDocumentOld

getThumbnailForDocumentOld(requestParameters: GetThumbnailForDocumentOldRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTThumbnailInfo>
Retrieve thumbnail information for a document in default workspace by document ID.
Parameters
- requestParameters: GetThumbnailForDocumentOldRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTThumbnailInfo>
- Defined in apis/ThumbnailApi.ts:614

getThumbnailForDocumentOldRaw

getThumbnailForDocumentOldRaw(requestParameters: GetThumbnailForDocumentOldRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTThumbnailInfo>>
Retrieve thumbnail information for a document in default workspace by document ID.
Parameters
- requestParameters: GetThumbnailForDocumentOldRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTThumbnailInfo>>
- Defined in apis/ThumbnailApi.ts:584

getThumbnailForDocumentRaw

getThumbnailForDocumentRaw(requestParameters: GetThumbnailForDocumentRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTThumbnailInfo>>
Retrieve thumbnail information for document in default workspace by document ID.
Parameters
- requestParameters: GetThumbnailForDocumentRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTThumbnailInfo>>
- Defined in apis/ThumbnailApi.ts:460

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

setApplicationElementThumbnail

setApplicationElementThumbnail(requestParameters: SetApplicationElementThumbnailRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update application tab thumbnail by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: SetApplicationElementThumbnailRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ThumbnailApi.ts:679

setApplicationElementThumbnailRaw

setApplicationElementThumbnailRaw(requestParameters: SetApplicationElementThumbnailRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update application tab thumbnail by document ID, workspace or version ID, and tab ID.
Parameters
- requestParameters: SetApplicationElementThumbnailRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ThumbnailApi.ts:622

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Class ThumbnailApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns ThumbnailApi

Properties

Protected configuration

Methods

deleteApplicationThumbnails

Parameters

requestParameters: DeleteApplicationThumbnailsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

deleteApplicationThumbnailsRaw

Parameters

requestParameters: DeleteApplicationThumbnailsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getDocumentThumbnail

Parameters

requestParameters: GetDocumentThumbnailRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTThumbnailInfo>

getDocumentThumbnailRaw

Parameters

requestParameters: GetDocumentThumbnailRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTThumbnailInfo>>

getDocumentThumbnailWithSize

Parameters

requestParameters: GetDocumentThumbnailWithSizeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

getDocumentThumbnailWithSizeRaw

Parameters

requestParameters: GetDocumentThumbnailWithSizeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getElementThumbnail

Parameters

requestParameters: GetElementThumbnailRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTThumbnailInfo>

getElementThumbnailRaw

Parameters

requestParameters: GetElementThumbnailRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTThumbnailInfo>>

getElementThumbnailWithApiConfiguration

Parameters

requestParameters: GetElementThumbnailWithApiConfigurationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

getElementThumbnailWithApiConfigurationRaw

Parameters

requestParameters: GetElementThumbnailWithApiConfigurationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getElementThumbnailWithSize

Parameters

requestParameters: GetElementThumbnailWithSizeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

getElementThumbnailWithSizeRaw

Parameters

requestParameters: GetElementThumbnailWithSizeRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getThumbnailForDocument

Parameters

requestParameters: GetThumbnailForDocumentRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTThumbnailInfo>

getThumbnailForDocumentAndVersion

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]