TimezoneURL class

  • Reference
Package:
azure-maps-rest

A TimezoneURL represents a URL to the Azure Maps timezone operations.

Extends
MapsURL

Constructors

TimezoneURL(Pipeline, string)

Creates an instance of TimezoneURL.

Inherited Properties

mapsUrl

Base URL string value.

Methods

getTimezoneByCoordinates(Aborter, GeoJSON.Position, GetTimezoneByCoordinatesOptions)

This API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location. Uses the Get Timezone By Coordinates API: https://docs.microsoft.com/rest/api/maps/timezone/gettimezonebycoordinates
getTimezoneById(Aborter, string, GetTimezoneByIdOptions)

This API returns current, historical, and future time zone information for the specified IANA time zone ID. Uses the Get Timezone By ID API: https://docs.microsoft.com/rest/api/maps/timezone/gettimezonebyid

Inherited Methods

newPipeline(Credential, INewPipelineOptions)

A static method used to create a new Pipeline object with Credential provided.

Constructor Details

TimezoneURL(Pipeline, string)

Creates an instance of TimezoneURL.

new TimezoneURL(pipeline: Pipeline, mapsUrl?: string)

Parameters

pipeline
Pipeline

Call MapsURL.newPipeline() to create a default pipeline, or provide a customized pipeline.

mapsUrl

string

A URL string pointing to Azure Maps service, default is "https://atlas.microsoft.com". If no protocol is specified, e.g. "atlas.microsoft.com", then https will be assumed.

Inherited Property Details

mapsUrl

Base URL string value.

mapsUrl: string

Property Value

string

Inherited From MapsURL.mapsUrl

Method Details

getTimezoneByCoordinates(Aborter, GeoJSON.Position, GetTimezoneByCoordinatesOptions)

This API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location. Uses the Get Timezone By Coordinates API: https://docs.microsoft.com/rest/api/maps/timezone/gettimezonebycoordinates

function getTimezoneByCoordinates(aborter: Aborter, coordinate: GeoJSON.Position, options?: GetTimezoneByCoordinatesOptions): Promise<GetTimezoneByCoordinatesResponse>

Parameters

aborter
Aborter
coordinate
GeoJSON.Position

Coordinates of the point for which time zone information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".

options
GetTimezoneByCoordinatesOptions

Returns

Promise<GetTimezoneByCoordinatesResponse>

getTimezoneById(Aborter, string, GetTimezoneByIdOptions)

This API returns current, historical, and future time zone information for the specified IANA time zone ID. Uses the Get Timezone By ID API: https://docs.microsoft.com/rest/api/maps/timezone/gettimezonebyid

function getTimezoneById(aborter: Aborter, id: string, options?: GetTimezoneByIdOptions): Promise<GetTimezoneByIdResponse>

Parameters

aborter
Aborter
id

string

The IANA time zone ID.

options
GetTimezoneByIdOptions

Returns

Promise<GetTimezoneByIdResponse>

Inherited Method Details

newPipeline(Credential, INewPipelineOptions)

A static method used to create a new Pipeline object with Credential provided.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Parameters

credential
Credential

Such as SubscriptionKeyCredential, TokenCredential, and MapControlCredential.

pipelineOptions
INewPipelineOptions

Returns

Pipeline

A new Pipeline object.

Inherited From MapsURL.newPipeline