Module @sap/cloud-sdk-vdm-cloud-print-pull-service

Index

References

Classes

Interfaces

Type aliases

Variables

defaultCloudPrintPullServicePath

Functions

Object literals

functionImports

References

FuncImpReturn

Re-exports FuncImpReturn

FuncImpReturnRequestBuilder

Re-exports FuncImpReturnRequestBuilder

FuncImpReturnType

Re-exports FuncImpReturnType

FuncImpReturnTypeForceMandatory

Re-exports FuncImpReturnTypeForceMandatory

GetIcmCacheParameters

Re-exports GetIcmCacheParameters

GetPrintOptionsParameters

Re-exports GetPrintOptionsParameters

GetPrintQueuesOfUserParameters

Re-exports GetPrintQueuesOfUserParameters

GetQItemDocumentParameters

Re-exports GetQItemDocumentParameters

IcmCacheResult

Re-exports IcmCacheResult

IcmCacheResultRequestBuilder

Re-exports IcmCacheResultRequestBuilder

IcmCacheResultType

Re-exports IcmCacheResultType

IcmCacheResultTypeForceMandatory

Re-exports IcmCacheResultTypeForceMandatory

PrintDocumentBlobSet

Re-exports PrintDocumentBlobSet

PrintDocumentBlobSetRequestBuilder

Re-exports PrintDocumentBlobSetRequestBuilder

PrintDocumentBlobSetType

Re-exports PrintDocumentBlobSetType

PrintDocumentBlobSetTypeForceMandatory

Re-exports PrintDocumentBlobSetTypeForceMandatory

PrintOptions

Re-exports PrintOptions

PrintOptionsRequestBuilder

Re-exports PrintOptionsRequestBuilder

PrintOptionsType

Re-exports PrintOptionsType

PrintOptionsTypeForceMandatory

Re-exports PrintOptionsTypeForceMandatory

PrintQueueInfoSet

Re-exports PrintQueueInfoSet

PrintQueueInfoSetRequestBuilder

Re-exports PrintQueueInfoSetRequestBuilder

PrintQueueInfoSetType

Re-exports PrintQueueInfoSetType

PrintQueueInfoSetTypeForceMandatory

Re-exports PrintQueueInfoSetTypeForceMandatory

ReadCloudPrintPullServiceRequestBuilder

Re-exports ReadCloudPrintPullServiceRequestBuilder

RetrieveNextItemResult

Re-exports RetrieveNextItemResult

RetrieveNextItemResultRequestBuilder

Re-exports RetrieveNextItemResultRequestBuilder

RetrieveNextItemResultType

Re-exports RetrieveNextItemResultType

RetrieveNextItemResultTypeForceMandatory

Re-exports RetrieveNextItemResultTypeForceMandatory

RetrieveNextQueueItemParameters

Re-exports RetrieveNextQueueItemParameters

SetPrintParameterParameters

Re-exports SetPrintParameterParameters

SetQItemStatusParameters

Re-exports SetQItemStatusParameters

WriteCloudPrintPullServiceRequestBuilder

Re-exports WriteCloudPrintPullServiceRequestBuilder

batch

Re-exports batch

changeset

Re-exports changeset

defaultCloudPrintPullServicePath

Re-exports defaultCloudPrintPullServicePath

functionImports

Re-exports functionImports

getIcmCache

Re-exports getIcmCache

getPrintOptions

Re-exports getPrintOptions

getPrintQueuesOfUser

Re-exports getPrintQueuesOfUser

getQItemDocument

Re-exports getQItemDocument

retrieveNextQueueItem

Re-exports retrieveNextQueueItem

setPrintParameter

Re-exports setPrintParameter

setQItemStatus

Re-exports setQItemStatus

Type aliases

ReadCloudPrintPullServiceRequestBuilder

ReadCloudPrintPullServiceRequestBuilder: GetAllRequestBuilder<IcmCacheResult> | GetAllRequestBuilder<RetrieveNextItemResult> | GetAllRequestBuilder<PrintQueueInfoSet> | GetAllRequestBuilder<PrintDocumentBlobSet> | GetAllRequestBuilder<PrintOptions> | GetAllRequestBuilder<FuncImpReturn> | GetByKeyRequestBuilder<IcmCacheResult> | GetByKeyRequestBuilder<RetrieveNextItemResult> | GetByKeyRequestBuilder<PrintQueueInfoSet> | GetByKeyRequestBuilder<PrintDocumentBlobSet> | GetByKeyRequestBuilder<PrintOptions> | GetByKeyRequestBuilder<FuncImpReturn>

WriteCloudPrintPullServiceRequestBuilder

WriteCloudPrintPullServiceRequestBuilder: CreateRequestBuilder<IcmCacheResult> | UpdateRequestBuilder<IcmCacheResult> | DeleteRequestBuilder<IcmCacheResult> | CreateRequestBuilder<RetrieveNextItemResult> | UpdateRequestBuilder<RetrieveNextItemResult> | DeleteRequestBuilder<RetrieveNextItemResult> | CreateRequestBuilder<PrintQueueInfoSet> | UpdateRequestBuilder<PrintQueueInfoSet> | DeleteRequestBuilder<PrintQueueInfoSet> | CreateRequestBuilder<PrintDocumentBlobSet> | UpdateRequestBuilder<PrintDocumentBlobSet> | DeleteRequestBuilder<PrintDocumentBlobSet> | CreateRequestBuilder<PrintOptions> | UpdateRequestBuilder<PrintOptions> | DeleteRequestBuilder<PrintOptions> | CreateRequestBuilder<FuncImpReturn> | UpdateRequestBuilder<FuncImpReturn> | DeleteRequestBuilder<FuncImpReturn>

Variables

Const defaultCloudPrintPullServicePath

defaultCloudPrintPullServicePath: "/sap/opu/odata/sap/API_CLOUD_PRINT_PULL_SRV" = "/sap/opu/odata/sap/API_CLOUD_PRINT_PULL_SRV"

Functions

batch

batch(...requests: Array<ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSet<WriteCloudPrintPullServiceRequestBuilder>>): ODataBatchRequestBuilder

- Defined in packages/vdm/cloud-print-pull-service/BatchRequest.ts:14
Batch builder for operations supported on the Cloud Print Pull Service.

Parameters
- Rest ...requests: Array<ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSet<WriteCloudPrintPullServiceRequestBuilder>>
  
  The requests of the batch
Returns ODataBatchRequestBuilder

A request builder for batch.

changeset

changeset(...requests: WriteCloudPrintPullServiceRequestBuilder[]): ODataBatchChangeSet<WriteCloudPrintPullServiceRequestBuilder>

- Defined in packages/vdm/cloud-print-pull-service/BatchRequest.ts:23
Change set constructor consists of write operations supported on the Cloud Print Pull Service.

Parameters
- Rest ...requests: WriteCloudPrintPullServiceRequestBuilder[]
  
  The requests of the change set
Returns ODataBatchChangeSet<WriteCloudPrintPullServiceRequestBuilder>

A change set for batch.

getIcmCache

getIcmCache(parameters: GetIcmCacheParameters): FunctionImportRequestBuilder<GetIcmCacheParameters, IcmCacheResult>

- Defined in packages/vdm/cloud-print-pull-service/function-imports.ts:55
Reads the ICM cache.

Parameters
- parameters: GetIcmCacheParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<GetIcmCacheParameters, IcmCacheResult>

A request builder that allows to overwrite some of the values and execute the resultng request.

getPrintOptions

getPrintOptions(parameters: GetPrintOptionsParameters): FunctionImportRequestBuilder<GetPrintOptionsParameters, PrintOptions>

- Defined in packages/vdm/cloud-print-pull-service/function-imports.ts:181
Reads print options.

Parameters
- parameters: GetPrintOptionsParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<GetPrintOptionsParameters, PrintOptions>

A request builder that allows to overwrite some of the values and execute the resultng request.

getPrintQueuesOfUser

getPrintQueuesOfUser(parameters: GetPrintQueuesOfUserParameters): FunctionImportRequestBuilder<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>

- Defined in packages/vdm/cloud-print-pull-service/function-imports.ts:75
Reads all print queues.

Parameters
- parameters: GetPrintQueuesOfUserParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

getQItemDocument

getQItemDocument(parameters: GetQItemDocumentParameters): FunctionImportRequestBuilder<GetQItemDocumentParameters, PrintDocumentBlobSet[]>

- Defined in packages/vdm/cloud-print-pull-service/function-imports.ts:150
Reads document.

Parameters
- parameters: GetQItemDocumentParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<GetQItemDocumentParameters, PrintDocumentBlobSet[]>

A request builder that allows to overwrite some of the values and execute the resultng request.

retrieveNextQueueItem

retrieveNextQueueItem(parameters: RetrieveNextQueueItemParameters): FunctionImportRequestBuilder<RetrieveNextQueueItemParameters, RetrieveNextItemResult>

- Defined in packages/vdm/cloud-print-pull-service/function-imports.ts:34
Reads next item.

Parameters
- parameters: RetrieveNextQueueItemParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<RetrieveNextQueueItemParameters, RetrieveNextItemResult>

A request builder that allows to overwrite some of the values and execute the resultng request.

setPrintParameter

setPrintParameter(parameters: SetPrintParameterParameters): FunctionImportRequestBuilder<SetPrintParameterParameters, FuncImpReturn>

- Defined in packages/vdm/cloud-print-pull-service/function-imports.ts:210
Sets print options.

Parameters
- parameters: SetPrintParameterParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<SetPrintParameterParameters, FuncImpReturn>

A request builder that allows to overwrite some of the values and execute the resultng request.

setQItemStatus

setQItemStatus(parameters: SetQItemStatusParameters): FunctionImportRequestBuilder<SetQItemStatusParameters, FuncImpReturn>

- Defined in packages/vdm/cloud-print-pull-service/function-imports.ts:111
Sets status of printed document.

Parameters
- parameters: SetQItemStatusParameters
  
  Object containing all parameters for the function import.
Returns FunctionImportRequestBuilder<SetQItemStatusParameters, FuncImpReturn>

A request builder that allows to overwrite some of the values and execute the resultng request.

Object literals

Const functionImports

functionImports: object

getIcmCache

getIcmCache: getIcmCache

getPrintOptions

getPrintOptions: getPrintOptions

getPrintQueuesOfUser

getPrintQueuesOfUser: getPrintQueuesOfUser

getQItemDocument

getQItemDocument: getQItemDocument

retrieveNextQueueItem

retrieveNextQueueItem: retrieveNextQueueItem

setPrintParameter

setPrintParameter: setPrintParameter

setQItemStatus

setQItemStatus: setQItemStatus