Class BatchRequest

The batch request class is used for grouping requests into a single batch request to execute on the server.

Hierarchy

ExecutableRequest
- BatchRequest

Constructors

constructor

new BatchRequest(requestOptions: BatchRequestOptionsExtended, token: Token, sdkOptions: SDKOptions): BatchRequest
Parameters
- requestOptions: BatchRequestOptionsExtended
- token: Token
- sdkOptions: SDKOptions
Returns BatchRequest
Overrides ExecutableRequest.constructor
- Defined in Requests/BatchRequest.ts:264

Properties

`Protected` action

action: string

`Private` boundary

boundary: string

counter

counter: number

`Private` factory

factory: RequestFactory

failureCb

failureCb: Function

`Protected` http

http: XMLHttpRequest

key

key: string | number

progressCb

progressCb: Function

`Protected` query

query: Query

requests

requests: BatchInnerRequest[]

`Private` responseHeaderRegex

responseHeaderRegex: RegExp

`Private` responseStatusRegex

responseStatusRegex: RegExp

successCb

successCb: Function

urlOptions

urlOptions: TypeOptions

`Static` constants

constants: {
newLine: string;
} = ...

Type declaration

newLine: string

Methods

`Protected` addQueryParameters

addQueryParameters(url: string): string
Parameters
- url: string
Returns string
Inherited from ExecutableRequest.addQueryParameters
- Defined in Requests/RequestBase.ts:98

`Private` addRequest

addRequest(request: RequestBase): number
Parameters
- request: RequestBase
Returns number
- Defined in Requests/BatchRequest.ts:754

beginTransaction

beginTransaction(): Transaction
Begins a transaction.

Returns Transaction
- Defined in Requests/BatchRequest.ts:380

`Private` buildRequest

buildRequest(request: RequestBase): Blob
Parameters
- request: RequestBase
Returns Blob
- Defined in Requests/BatchRequest.ts:682

`Private` buildRequestBody

buildRequestBody(): Blob
Returns Blob
- Defined in Requests/BatchRequest.ts:658

`Private` buildTransaction

buildTransaction(transaction: Transaction): Blob
Parameters
- transaction: Transaction
Returns Blob
- Defined in Requests/BatchRequest.ts:694

buildUrl

buildUrl(): string
Returns string
Overrides ExecutableRequest.buildUrl
- Defined in Requests/BatchRequest.ts:413

`Private` contentType

contentType(str: any): {
mediaType: any;
properties: {};
}
Parameters
- str: any
Returns {
mediaType: any;
properties: {};
}
- mediaType: any
- properties: {}
- Defined in Requests/BatchRequest.ts:573

`Private` createBoundary

createBoundary(prefix: any): string
Parameters
- prefix: any
Returns string
- Defined in Requests/BatchRequest.ts:750

`Private` createDelimeter

createDelimeter(boundary: any, close: any, shouldAddSingleNewLine?: boolean): string
Parameters
- boundary: any
- close: any
- shouldAddSingleNewLine: boolean = false
Returns string
- Defined in Requests/BatchRequest.ts:736

`Private` currentBoundary

currentBoundary(context: any): any
Parameters
- context: any
Returns any
- Defined in Requests/BatchRequest.ts:568

endTransaction

endTransaction(transaction: Transaction): void
Ends a transaction.
Parameters
- transaction: Transaction
Returns void
- Defined in Requests/BatchRequest.ts:390

execute

execute(): void
Returns void
Inherited from ExecutableRequest.execute
- Defined in Requests/ExecutableRequest.ts:24

`Protected` executeProgressEvent

executeProgressEvent(): void
Returns void
Inherited from ExecutableRequest.executeProgressEvent
- Defined in Requests/ExecutableRequest.ts:68

get

get(parameters: BatchRequestOptionsBase): void
Adds a GET request to retrieve a collection of items.
Parameters
- parameters: BatchRequestOptionsBase
Returns void
- Defined in Requests/BatchRequest.ts:277

getBody

getBody(): object
Returns object
Overrides ExecutableRequest.getBody
- Defined in Requests/BatchRequest.ts:397

getHeaders

getHeaders(): {
[key: string]: string;
}
Returns {
[key: string]: string;
}
- [key: string]: string
Overrides ExecutableRequest.getHeaders
- Defined in Requests/BatchRequest.ts:405

getMethod

getMethod(): string
Returns string
Overrides ExecutableRequest.getMethod
- Defined in Requests/BatchRequest.ts:401

getProperty

getProperty(parameters: BatchPropertyRequestOptions): void
Adds a GET request to get the property of a single item.
Parameters
- parameters: BatchPropertyRequestOptions
Returns void
- Defined in Requests/BatchRequest.ts:319

getQueryString

getQueryString(urlOptions: TypeOptions, query: Query): string
Parameters
- urlOptions: TypeOptions
- query: Query
Returns string
Inherited from ExecutableRequest.getQueryString
- Defined in Requests/RequestBase.ts:28

getRelated

getRelated(parameters: BatchPropertyRequestOptions): void
Adds a GET request to get the related property value of a single item.
Parameters
- parameters: BatchPropertyRequestOptions
Returns void
- Defined in Requests/BatchRequest.ts:339

getRelatedById

getRelatedById(parameters: BatchSingleRelatedItemRequestOptions): void
Adds a GET request to retrieve the related property value of a single item by the id of the related item.
Parameters
- parameters: BatchSingleRelatedItemRequestOptions
Returns void
- Defined in Requests/BatchRequest.ts:359

`Private` getResponseResult

getResponseResult(response: any, key: any): {
    data: any;
    headers: any;
    key: any;
    statusCode: any;
}
Parameters
- response: any
- key: any
Returns {
    data: any;
    headers: any;
    key: any;
    statusCode: any;
}
- data: any
- headers: any
- key: any
- statusCode: any
- Defined in Requests/BatchRequest.ts:556

getSingle

getSingle(parameters: BatchSingleItemRequestOptions): void
Adds a GET request for the retrieval of a single item.
Parameters
- parameters: BatchSingleItemRequestOptions
Returns void
- Defined in Requests/BatchRequest.ts:298

`Private` parseBatchResponse

parseBatchResponse(text: any, context: any): any[]
Parameters
- text: any
- context: any
Returns any[]
- Defined in Requests/BatchRequest.ts:499

`Protected` parseResponse

parseResponse(http: XMLHttpRequest): any
Parameters
- http: XMLHttpRequest
Returns any
Overrides ExecutableRequest.parseResponse
- Defined in Requests/BatchRequest.ts:424

`Private` readHeaders

readHeaders(text: any, context: any): {}
Parameters
- text: any
- context: any
Returns {}
- Defined in Requests/BatchRequest.ts:611

`Private` readLine

readLine(text: any, context: any): any
Parameters
- text: any
- context: any
Returns any
- Defined in Requests/BatchRequest.ts:607

`Private` readResponse

readResponse(text: any, context: any, delimiter: any): {
    body: any;
    headers: any;
    statusCode: any;
    statusText: any;
}
Parameters
- text: any
- context: any
- delimiter: any
Returns {
    body: any;
    headers: any;
    statusCode: any;
    statusText: any;
}
- body: any
- headers: any
- statusCode: any
- statusText: any
- Defined in Requests/BatchRequest.ts:632

`Private` readTo

readTo(text: any, str: any, context: any): any
Parameters
- text: any
- str: any
- context: any
Returns any
- Defined in Requests/BatchRequest.ts:591

`Private` urlParametersClone

urlParametersClone(entitySet: string): TypeOptions
Parameters
- entitySet: string
Returns TypeOptions
- Defined in Requests/BatchRequest.ts:759

Generated using TypeDoc