TimezoneGetTimezoneByCoordinatesOptionalParams interface

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

azure-maps-rest

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal	The signal which can be used to abort requests.
acceptLanguage	Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to Supported Languages for details.
customHeaders	{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
options	Alternatively, use alias "o". Options available for types of information returned in the result. Possible values include: 'none', 'zoneInfo', 'transitions', 'all'
timeout	The number of milliseconds a request can take before automatically being terminated.
timeStamp	Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request.
transitionsFrom	Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions.
transitionsYears	Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

acceptLanguage

Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to Supported Languages for details.

acceptLanguage?: string

Property Value

string

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: [key: string]: string

Property Value

[key: string]: string

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

options

Alternatively, use alias "o". Options available for types of information returned in the result. Possible values include: 'none', 'zoneInfo', 'transitions', 'all'

options?: TimezoneOptions

Property Value

TimezoneOptions

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

timeStamp

Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request.

timeStamp?: Date

Property Value

Date

transitionsFrom

Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions.

transitionsFrom?: Date

Property Value

Date

transitionsYears

Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions.

transitionsYears?: number

Property Value

number