Class OData

OData Client

Hierarchy

OData

Index

Constructors

constructor

Properties

Constructors

constructor

new OData(metadataUri: string, credential?: Credential, headers?: any, urlRewrite?: (string: any) => string, fetchProxy?: FetchProxy, processCsrfToken?: boolean): OData

- Defined in build/repo/src/request.ts:136
OData

deprecated

please use static method create instance

Parameters
- metadataUri: string
- Optional credential: Credential
- headers: any = ...
- Optional urlRewrite: (string: any) => string
  - - (string: any): string
    - Parameters
      - string: any
      Returns string
- Optional fetchProxy: FetchProxy
- processCsrfToken: boolean = false
Returns OData

Properties

Private commonHeader

commonHeader: {} = ...

dont direct use this object

Type declaration

[headerName: string]: string

Private credential

credential: Credential

http basic credential

Private csrfToken

csrfToken: string = ''

internal csrf token

Private fetchProxy

fetchProxy: FetchProxy = ...

Private metadataUri

metadataUri: string

Private oauthClient

oauthClient: ClientCredentialsOAuthClient

oauth client

Private odataEnd

odataEnd: string

odata service path, like /sap/c4c/odata/v1/c4codata/

Private processCsrfToken

processCsrfToken: boolean = false

Private variant

variant: ODataVariant = 'default'

Private version

version: ODataVersion = 'v2'

Methods

Private _executeActionOrFunction

_executeActionOrFunction(options: ODataFunctionRequest | ODataActionRequest): Promise<PlainODataMultiResponse<any>>

- Defined in build/repo/src/request.ts:395
Parameters
- options: ODataFunctionRequest | ODataActionRequest
Returns Promise<PlainODataMultiResponse<any>>

Private _executeDataOperation

_executeDataOperation<T>(collection: string, id?: any, queryParams?: ODataQueryParam<any>, method?: HTTPMethod, entity?: any): Promise<PlainODataMultiResponse<T>>

- Defined in build/repo/src/request.ts:320
odata request

Type parameters
- T = any
Parameters
- collection: string
  
  CollectionName
- Optional id: any
  
  entity uuid or compound key
- Optional queryParams: ODataQueryParam<any>
  
  query param, not work for single entity uri
- method: HTTPMethod = 'GET'
  
  request method
- Optional entity: any
  
  C4C Entity instance
Returns Promise<PlainODataMultiResponse<T>>

cleanCsrfToken

cleanCsrfToken(): void

- Defined in build/repo/src/request.ts:266
Returns void

execBatchRequests

execBatchRequests<T>(requests: T): BatchResponses<T>

- Defined in build/repo/src/request.ts:468
execute batch requests and get response

Type parameters
- T: Promise<BatchRequest<any>>[] = any
Parameters
- requests: T
  
  batch request
Returns BatchResponses<T>

execBatchRequestsJson

execBatchRequestsJson<T>(requests: T): BatchResponses<T>

- Defined in build/repo/src/request.ts:484
execute batch requests in OData V4.01 Json format, and get response

Type parameters
- T: Promise<BatchRequest<any>>[] = any
Parameters
- requests: T
Returns BatchResponses<T>

Private formatBatchRequests

formatBatchRequests(requests: Promise<BatchRequest<any>>[]): Promise<{ req: RequestInit; url: string }>

- Defined in build/repo/src/request.ts:447
format batch request parameter

Parameters
- requests: Promise<BatchRequest<any>>[]
Returns Promise<{ req: RequestInit; url: string }>

Private formatIdString

formatIdString(id: any): string

- Defined in build/repo/src/request.ts:339
format id part of url

Parameters
- id: any
Returns string

Private getCsrfToken

getCsrfToken(): Promise<string>

- Defined in build/repo/src/request.ts:242
fetch CSRF Token

Returns Promise<string>

getEntitySet

getEntitySet<T>(entitySetName: string): EntitySet<T>

- Defined in build/repo/src/request.ts:211
getEntitySet

Type parameters
- T
Parameters
- entitySetName: string
  
  the name of entity set, you can get it from metadata
Returns EntitySet<T>

Private getHeaders

getHeaders(): Promise<{}>

- Defined in build/repo/src/request.ts:182
generate dynamic header

Returns Promise<{}>

getVersion

getVersion(): ODataVersion

- Defined in build/repo/src/request.ts:235
Returns ODataVersion

newBatchRequest

newBatchRequest<T>(options: BatchRequestOptions<T>): Promise<BatchRequest<T>>

- Defined in build/repo/src/request.ts:533
Type parameters
- T
Parameters
- options: BatchRequestOptions<T>
Returns Promise<BatchRequest<T>>

newFilter

newFilter(): ODataFilter<any>

- Defined in build/repo/src/request.ts:520
create new filter

alias

OData.newFilter

Returns ODataFilter<any>

newParam

newParam(): ODataQueryParam<any>

- Defined in build/repo/src/request.ts:529
create new param

alias

OData.newParam

Returns ODataQueryParam<any>

newRequest

newRequest<T>(options: ODataQueryRequest<T>): Promise<PlainODataMultiResponse<T>>
newRequest<T>(options: ODataWriteRequest<T>): Promise<PlainODataSingleResponse<T>>
newRequest<T>(options: ODataReadIDRequest<T>): Promise<PlainODataSingleResponse<T>>
newRequest(options: ODataFunctionRequest): Promise<PlainODataResponse>
newRequest(options: ODataActionRequest): Promise<PlainODataResponse>

- Defined in build/repo/src/request.ts:383
new odata http request

Type parameters
- T
Parameters
- options: ODataQueryRequest<T>
Returns Promise<PlainODataMultiResponse<T>>
- Defined in build/repo/src/request.ts:384
Type parameters
- T
Parameters
- options: ODataWriteRequest<T>
Returns Promise<PlainODataSingleResponse<T>>
- Defined in build/repo/src/request.ts:385
Type parameters
- T
Parameters
- options: ODataReadIDRequest<T>
Returns Promise<PlainODataSingleResponse<T>>
- Defined in build/repo/src/request.ts:386
Parameters
- options: ODataFunctionRequest
Returns Promise<PlainODataResponse>
- Defined in build/repo/src/request.ts:387
Parameters
- options: ODataActionRequest
Returns Promise<PlainODataResponse>

Private requestUri

requestUri<T>(uri: string, queryParams?: ODataQueryParam<any>, method?: HTTPMethod, body?: any): Promise<PlainODataMultiResponse<T>>

- Defined in build/repo/src/request.ts:278
odata request uri

Type parameters
- T = any
Parameters
- uri: string
  
  HTTP URI
- Optional queryParams: ODataQueryParam<any>
  
  odata query params
- method: HTTPMethod = 'GET'
  
  HTTP method
- Optional body: any
  
  request content
Returns Promise<PlainODataMultiResponse<T>>

setCredential

setCredential(credential: Credential): void

- Defined in build/repo/src/request.ts:220
Set OData Client Http Basic credential

Parameters
- credential: Credential
Returns void

setODataEndPath

setODataEndPath(odataEnd: string): void

- Defined in build/repo/src/request.ts:229
setODataEndPath

e.g. https://tenant.c4c.saphybriscloud.cn/sap/c4c/odata/v1/c4codata/

Parameters
- odataEnd: string
Returns void

Static New

New(options: ODataNewOptions): OData

- Defined in build/repo/src/request.ts:92
alternative constructor

Parameters
- options: ODataNewOptions
  
  config options
Returns OData

Static New4

New4(options: ODataNewOptions): ODataV4

- Defined in build/repo/src/request.ts:118
create odata client instance for odata v4

Parameters
- options: ODataNewOptions
Returns ODataV4

Static newFilter

newFilter(): ODataFilter<any>

- Defined in build/repo/src/request.ts:134
new filter

Returns ODataFilter<any>

Static newParam

newParam(): ODataQueryParam<any>

- Defined in build/repo/src/request.ts:127
new odata query param

Returns ODataQueryParam<any>

Generated using TypeDoc