map module

Package:

@microsoft/teams-js

Note

This namespace is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Namespace to interact with the location on map module-specific part of the SDK.

Functions

chooseLocation()	Allows user to choose location on map
isSupported()	Checks if geoLocation.map capability is supported by the host
showLocation(Location)	Shows the location on map corresponding to the given coordinates

Function Details

chooseLocation()

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Allows user to choose location on map

function chooseLocation(): Promise<Location>

Returns

Promise<Location>

Promise that will resolve with Location object chosen by the user or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error

isSupported()

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Checks if geoLocation.map capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether geoLocation.map is supported

showLocation(Location)

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Shows the location on map corresponding to the given coordinates

function showLocation(location: Location): Promise<void>

Parameters

location

Location

Location to be shown on the map

Returns

Promise<void>

Promise that resolves when the location dialog has been closed or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error