Class GetByIdRequest

Hierarchy

ExecutableRequest
- GetByIdRequest
  - GetRelatedRequest
  - GetRelatedByIdRequest

Index

Constructors

Properties

action failureCb http key progressCb query successCb urlOptions

Methods

addQueryParameters buildUrl execute executeProgressEvent getBody getHeaders getMethod getQueryString parseResponse

Constructors

constructor

new GetByIdRequest(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions): GetByIdRequest
Parameters
- requestOptions: RequestOptionsBaseExtended
- token: Token
- sdkOptions: SDKOptions
Returns GetByIdRequest
Overrides ExecutableRequest.constructor
- Defined in Requests/Request.ts:18

Properties

`Protected` action

action: string

failureCb

failureCb: Function

`Protected` http

http: XMLHttpRequest

key

key: string | number

progressCb

progressCb: Function

`Protected` query

query: Query

successCb

successCb: Function

urlOptions

urlOptions: TypeOptions

Methods

`Protected` addQueryParameters

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

buildUrl

buildUrl(): string
Returns string
Inherited from ExecutableRequest.buildUrl
- Defined in Requests/RequestBase.ts:63

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

getBody

getBody(): object
Returns object
Inherited from ExecutableRequest.getBody
- Defined in Requests/RequestBase.ts:46

getHeaders

getHeaders(): {
[key: string]: string;
}
Returns {
[key: string]: string;
}
- [key: string]: string
Inherited from ExecutableRequest.getHeaders
- Defined in Requests/RequestBase.ts:54

getMethod

getMethod(): string
Returns string
Overrides ExecutableRequest.getMethod
- Defined in Requests/Request.ts:22

getQueryString

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

`Protected` parseResponse

parseResponse(http: XMLHttpRequest): any
Parameters
- http: XMLHttpRequest
Returns any
Inherited from ExecutableRequest.parseResponse
- Defined in Requests/RequestBase.ts:85

Generated using TypeDoc