Class GlobalRequestModel

Represents a model for global HTTP requests configuration. This class encapsulates all necessary details such as URL, query parameters, body, headers, timeout settings, and development mode flag.

Index

Constructors

constructor

Methods

getBaseUrl getBody getDevelopmentMode getHeaders getQuery getTimeout setBaseUrl setBody setDevelopmentMode setHeaders setQuery setTimeout

Constructors

constructor

new GlobalRequestModel(url, query, body, headers): GlobalRequestModel
Constructs an instance of the GlobalRequestModel.
Parameters
- url: string
  The base URL of the HTTP request.
- query: Record<string, dynamic>
  Query parameters as a record of key-value pairs.
- body: Record<string, dynamic>
  Body of the request as a record of key-value pairs.
- headers: Record<string, any>
  HTTP headers as a record of key-value pairs.
Returns GlobalRequestModel
- Defined in packages/network-layer/models/GlobalRequestModel.ts:38

Properties

`Private` body

body: Record<string, dynamic>

`Private` headers

headers: Record<string, string>

`Private` isDevelopmentMode

isDevelopmentMode: boolean

`Private` query

query: Record<string, dynamic>

`Private` timeout

timeout: number = 3000

`Private` url

url: string

Methods

getBaseUrl

getBaseUrl(): string
Retrieves the base URL of the HTTP request.

Returns string
The base URL as a string.
- Defined in packages/network-layer/models/GlobalRequestModel.ts:94

getBody

getBody(): Record<string, dynamic>
Retrieves the body of the HTTP request.

Returns Record<string, dynamic>
A record of key-value pairs representing the body content.
- Defined in packages/network-layer/models/GlobalRequestModel.ts:78

getDevelopmentMode

getDevelopmentMode(): boolean
Retrieves the development mode status of the request.

Returns boolean
Boolean indicating if the request is in development mode.
- Defined in packages/network-layer/models/GlobalRequestModel.ts:142

getHeaders

getHeaders(): Record<string, string>
Retrieves the HTTP headers of the request.

Returns Record<string, string>
A record of key-value pairs representing the HTTP headers.
- Defined in packages/network-layer/models/GlobalRequestModel.ts:126

getQuery

getQuery(): Record<string, dynamic>
Retrieves the query parameters of the HTTP request.

Returns Record<string, dynamic>
A record of key-value pairs representing the query parameters.
- Defined in packages/network-layer/models/GlobalRequestModel.ts:62

getTimeout

getTimeout(): number
Retrieves the timeout duration of the HTTP request.

Returns number
Timeout in milliseconds.
- Defined in packages/network-layer/models/GlobalRequestModel.ts:110

setBaseUrl

setBaseUrl(url): void
Sets the base URL of the HTTP request.
Parameters
- url: string
  The base URL as a string.
Returns void
- Defined in packages/network-layer/models/GlobalRequestModel.ts:86

setBody

setBody(body): void
Sets the body of the HTTP request.
Parameters
- body: Record<string, dynamic>
  A record of key-value pairs representing the body content.
Returns void
- Defined in packages/network-layer/models/GlobalRequestModel.ts:70

setDevelopmentMode

setDevelopmentMode(isDevelopmentMode): void
Sets the development mode status for the request.
Parameters
- isDevelopmentMode: boolean
  Boolean flag indicating if the request is in development mode.
Returns void
- Defined in packages/network-layer/models/GlobalRequestModel.ts:134

setHeaders

setHeaders(headers): void
Sets the HTTP headers for the request.
Parameters
- headers: Record<string, string>
  A record of key-value pairs representing the HTTP headers.
Returns void
- Defined in packages/network-layer/models/GlobalRequestModel.ts:118

setQuery

setQuery(query): void
Sets the query parameters for the HTTP request.
Parameters
- query: Record<string, dynamic>
  A record of key-value pairs representing the query parameters.
Returns void
- Defined in packages/network-layer/models/GlobalRequestModel.ts:54

setTimeout

setTimeout(timeout): void
Sets the timeout duration for the HTTP request.
Parameters
- timeout: number
  Timeout in milliseconds.
Returns void
- Defined in packages/network-layer/models/GlobalRequestModel.ts:102

Class GlobalRequestModel

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GlobalRequestModel

Properties

Private body

Private headers

Private isDevelopmentMode

Private query

Private timeout

Private url

Methods

getBaseUrl

Returns string

getBody

Returns Record<string, dynamic>

getDevelopmentMode

Returns boolean

getHeaders

Returns Record<string, string>

getQuery

Returns Record<string, dynamic>

getTimeout

Returns number

setBaseUrl

Parameters

Returns void

setBody

Parameters

Returns void

setDevelopmentMode

Parameters

Returns void

setHeaders

Parameters

Returns void

setQuery

Parameters

Returns void

setTimeout

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` body

`Private` headers

`Private` isDevelopmentMode

`Private` query

`Private` timeout

`Private` url