vdm/cloud-print-pull-service | SAP Cloud SDK for JavaScript / TypeScript

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ReadCloudPrintPullServiceRequestBuilder

ReadCloudPrintPullServiceRequestBuilder: GetAllRequestBuilderV2<IcmCacheResult> | GetAllRequestBuilderV2<RetrieveNextItemResult> | GetAllRequestBuilderV2<PrintQueueInfoSet> | GetAllRequestBuilderV2<PrintDocumentBlobSet> | GetAllRequestBuilderV2<PrintOptions> | GetAllRequestBuilderV2<FuncImpReturn> | GetByKeyRequestBuilderV2<IcmCacheResult> | GetByKeyRequestBuilderV2<RetrieveNextItemResult> | GetByKeyRequestBuilderV2<PrintQueueInfoSet> | GetByKeyRequestBuilderV2<PrintDocumentBlobSet> | GetByKeyRequestBuilderV2<PrintOptions> | GetByKeyRequestBuilderV2<FuncImpReturn>

WriteCloudPrintPullServiceRequestBuilder

WriteCloudPrintPullServiceRequestBuilder: CreateRequestBuilderV2<IcmCacheResult> | UpdateRequestBuilderV2<IcmCacheResult> | DeleteRequestBuilderV2<IcmCacheResult> | CreateRequestBuilderV2<RetrieveNextItemResult> | UpdateRequestBuilderV2<RetrieveNextItemResult> | DeleteRequestBuilderV2<RetrieveNextItemResult> | CreateRequestBuilderV2<PrintQueueInfoSet> | UpdateRequestBuilderV2<PrintQueueInfoSet> | DeleteRequestBuilderV2<PrintQueueInfoSet> | CreateRequestBuilderV2<PrintDocumentBlobSet> | UpdateRequestBuilderV2<PrintDocumentBlobSet> | DeleteRequestBuilderV2<PrintDocumentBlobSet> | CreateRequestBuilderV2<PrintOptions> | UpdateRequestBuilderV2<PrintOptions> | DeleteRequestBuilderV2<PrintOptions> | CreateRequestBuilderV2<FuncImpReturn> | UpdateRequestBuilderV2<FuncImpReturn> | DeleteRequestBuilderV2<FuncImpReturn>

Variables

Const defaultCloudPrintPullServicePath

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

Const functionImports

functionImports: { getIcmCache: (parameters: GetIcmCacheParameters) => FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>; getPrintOptions: (parameters: GetPrintOptionsParameters) => FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>; getPrintQueuesOfUser: (parameters: GetPrintQueuesOfUserParameters) => FunctionImportRequestBuilderV2<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>; getQItemDocument: (parameters: GetQItemDocumentParameters) => FunctionImportRequestBuilderV2<GetQItemDocumentParameters, PrintDocumentBlobSet[]>; retrieveNextQueueItem: (parameters: RetrieveNextQueueItemParameters) => FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>; setPrintParameter: (parameters: SetPrintParameterParameters) => FunctionImportRequestBuilderV2<SetPrintParameterParameters, FuncImpReturn>; setQItemStatus: (parameters: SetQItemStatusParameters) => FunctionImportRequestBuilderV2<SetQItemStatusParameters, FuncImpReturn> } = ...

Type declaration

getIcmCache: (parameters: GetIcmCacheParameters) => FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>
- - (parameters: GetIcmCacheParameters): FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>
  - Reads the ICM cache.
    
    Parameters
    - parameters: GetIcmCacheParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
getPrintOptions: (parameters: GetPrintOptionsParameters) => FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>
- - (parameters: GetPrintOptionsParameters): FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>
  - Reads print options.
    
    Parameters
    - parameters: GetPrintOptionsParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
getPrintQueuesOfUser: (parameters: GetPrintQueuesOfUserParameters) => FunctionImportRequestBuilderV2<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>
- - (parameters: GetPrintQueuesOfUserParameters): FunctionImportRequestBuilderV2<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>
  - Reads all print queues.
    
    Parameters
    - parameters: GetPrintQueuesOfUserParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
getQItemDocument: (parameters: GetQItemDocumentParameters) => FunctionImportRequestBuilderV2<GetQItemDocumentParameters, PrintDocumentBlobSet[]>
- - (parameters: GetQItemDocumentParameters): FunctionImportRequestBuilderV2<GetQItemDocumentParameters, PrintDocumentBlobSet[]>
  - Reads document.
    
    Parameters
    - parameters: GetQItemDocumentParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<GetQItemDocumentParameters, PrintDocumentBlobSet[]>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
retrieveNextQueueItem: (parameters: RetrieveNextQueueItemParameters) => FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>
- - (parameters: RetrieveNextQueueItemParameters): FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>
  - Reads next item.
    
    Parameters
    - parameters: RetrieveNextQueueItemParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
setPrintParameter: (parameters: SetPrintParameterParameters) => FunctionImportRequestBuilderV2<SetPrintParameterParameters, FuncImpReturn>
- - (parameters: SetPrintParameterParameters): FunctionImportRequestBuilderV2<SetPrintParameterParameters, FuncImpReturn>
  - Sets print options.
    
    Parameters
    - parameters: SetPrintParameterParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<SetPrintParameterParameters, FuncImpReturn>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.
setQItemStatus: (parameters: SetQItemStatusParameters) => FunctionImportRequestBuilderV2<SetQItemStatusParameters, FuncImpReturn>
- - (parameters: SetQItemStatusParameters): FunctionImportRequestBuilderV2<SetQItemStatusParameters, FuncImpReturn>
  - Sets status of printed document.
    
    Parameters
    - parameters: SetQItemStatusParameters
      
      Object containing all parameters for the function import.
    Returns FunctionImportRequestBuilderV2<SetQItemStatusParameters, FuncImpReturn>
    
    A request builder that allows to overwrite some of the values and execute the resulting request.

Functions

batch

batch(...requests: (ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>)[]): ODataBatchRequestBuilderV2
batch(requests: (ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>)[]): ODataBatchRequestBuilderV2

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

Parameters
- Rest ...requests: (ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>)[]
  
  The requests of the batch
Returns ODataBatchRequestBuilderV2

A request builder for batch.
- Defined in packages/vdm/cloud-print-pull-service/BatchRequest.ts:16
Parameters
- requests: (ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>)[]
Returns ODataBatchRequestBuilderV2

changeset

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

- Defined in packages/vdm/cloud-print-pull-service/BatchRequest.ts:26
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 ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>

A change set for batch.
- Defined in packages/vdm/cloud-print-pull-service/BatchRequest.ts:27
Parameters
- requests: WriteCloudPrintPullServiceRequestBuilder[]
Returns ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>

getIcmCache

getIcmCache(parameters: GetIcmCacheParameters): FunctionImportRequestBuilderV2<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 FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>

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

getPrintOptions

getPrintOptions(parameters: GetPrintOptionsParameters): FunctionImportRequestBuilderV2<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 FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>

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

getPrintQueuesOfUser

getPrintQueuesOfUser(parameters: GetPrintQueuesOfUserParameters): FunctionImportRequestBuilderV2<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 FunctionImportRequestBuilderV2<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>

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

getQItemDocument

getQItemDocument(parameters: GetQItemDocumentParameters): FunctionImportRequestBuilderV2<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 FunctionImportRequestBuilderV2<GetQItemDocumentParameters, PrintDocumentBlobSet[]>

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

retrieveNextQueueItem

retrieveNextQueueItem(parameters: RetrieveNextQueueItemParameters): FunctionImportRequestBuilderV2<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 FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>

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

setPrintParameter

setPrintParameter(parameters: SetPrintParameterParameters): FunctionImportRequestBuilderV2<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 FunctionImportRequestBuilderV2<SetPrintParameterParameters, FuncImpReturn>

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

setQItemStatus

setQItemStatus(parameters: SetQItemStatusParameters): FunctionImportRequestBuilderV2<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 FunctionImportRequestBuilderV2<SetQItemStatusParameters, FuncImpReturn>

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

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ReadCloudPrintPullServiceRequestBuilder

WriteCloudPrintPullServiceRequestBuilder

Variables

Const defaultCloudPrintPullServicePath

Const functionImports

Type declaration

getIcmCache: (parameters: GetIcmCacheParameters) => FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>

Parameters

parameters: GetIcmCacheParameters

Returns FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>

getPrintOptions: (parameters: GetPrintOptionsParameters) => FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>

Parameters

parameters: GetPrintOptionsParameters

Returns FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>

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

Parameters

parameters: GetPrintQueuesOfUserParameters

Returns FunctionImportRequestBuilderV2<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>

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

Parameters

parameters: GetQItemDocumentParameters

Returns FunctionImportRequestBuilderV2<GetQItemDocumentParameters, PrintDocumentBlobSet[]>

retrieveNextQueueItem: (parameters: RetrieveNextQueueItemParameters) => FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>

Parameters

parameters: RetrieveNextQueueItemParameters

Returns FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>

setPrintParameter: (parameters: SetPrintParameterParameters) => FunctionImportRequestBuilderV2<SetPrintParameterParameters, FuncImpReturn>

Parameters

parameters: SetPrintParameterParameters

Returns FunctionImportRequestBuilderV2<SetPrintParameterParameters, FuncImpReturn>

setQItemStatus: (parameters: SetQItemStatusParameters) => FunctionImportRequestBuilderV2<SetQItemStatusParameters, FuncImpReturn>

Parameters

parameters: SetQItemStatusParameters

Returns FunctionImportRequestBuilderV2<SetQItemStatusParameters, FuncImpReturn>

Functions

batch

Parameters

Rest ...requests: (ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>)[]

Returns ODataBatchRequestBuilderV2

Parameters

requests: (ReadCloudPrintPullServiceRequestBuilder | ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>)[]

Returns ODataBatchRequestBuilderV2

changeset

Parameters

Rest ...requests: WriteCloudPrintPullServiceRequestBuilder[]

Returns ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>

Parameters

requests: WriteCloudPrintPullServiceRequestBuilder[]

Returns ODataBatchChangeSetV2<WriteCloudPrintPullServiceRequestBuilder>

getIcmCache

Parameters

parameters: GetIcmCacheParameters

Returns FunctionImportRequestBuilderV2<GetIcmCacheParameters, IcmCacheResult>

getPrintOptions

Parameters

parameters: GetPrintOptionsParameters

Returns FunctionImportRequestBuilderV2<GetPrintOptionsParameters, PrintOptions>

getPrintQueuesOfUser

Parameters

parameters: GetPrintQueuesOfUserParameters

Returns FunctionImportRequestBuilderV2<GetPrintQueuesOfUserParameters, PrintQueueInfoSet[]>

getQItemDocument

Parameters

parameters: GetQItemDocumentParameters

Returns FunctionImportRequestBuilderV2<GetQItemDocumentParameters, PrintDocumentBlobSet[]>

retrieveNextQueueItem

Parameters

parameters: RetrieveNextQueueItemParameters

Returns FunctionImportRequestBuilderV2<RetrieveNextQueueItemParameters, RetrieveNextItemResult>

setPrintParameter

Parameters

parameters: SetPrintParameterParameters