mapwize-sdk-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

MapwizeApi is the entry point to retrieve Mapwize data from the Mapwize backend. It can be instantiated using CreateMapwizeAPI(mapwizeConfiguration:MapwizeConfiguration)

Hierarchy

  • MapwizeApi

Index

Properties

Properties

getAccess

getAccess: (accessKey: string) => Promise<boolean>

Gain access to private building using an access key

Type declaration

    • (accessKey: string): Promise<boolean>

    • Parameters

      • accessKey: string

      Returns Promise<boolean>

getAccessibleUniversesForVenue

getAccessibleUniversesForVenue: (venue: Venue) => Promise<Universe[]>

Get the list of universes that are accessible for this venue

Type declaration

getDirection

getDirection: (from: DirectionPoint, to: DirectionPoint | DirectionPoint[], mode: DirectionMode, waypoints?: DirectionPoint[], waypointsOptimize?: undefined | false | true) => Promise<Direction>

Get the direction between a starting point and a destination. The destination can be one or multiple DirectionPoint You can optionally add some waypoints

Type declaration

getDistances

getDistances: (from: DirectionPoint, to: DirectionPoint[], directionMode: DirectionMode, sortByTraveltime: boolean) => Promise<DistanceResponse>

Get the distances between a starting point and a list of destination

Type declaration

getLayer

getLayer: (id: string) => Promise<Layer>

Get a layer using its id

Type declaration

    • (id: string): Promise<Layer>

    • Parameters

      • id: string

      Returns Promise<Layer>

getLayerWithAlias

getLayerWithAlias: (alias: string, venue: Venue) => Promise<Layer>

Get a layer using its alias. As a layer alias is only unique in a specific venue, you have to pass this venue as parameter

Type declaration

    • Parameters

      • alias: string
      • venue: Venue

      Returns Promise<Layer>

getLayerWithName

getLayerWithName: (name: string, venue: Venue) => Promise<Layer>

Get a layer using its name. As a layer name is only unique in a specific venue, you have to pass this venue as parameter

Type declaration

    • Parameters

      • name: string
      • venue: Venue

      Returns Promise<Layer>

getLayers

getLayers: (params: ApiFilter) => Promise<Layer[]>

Get all the layers that match the ApiFilter

Type declaration

getMainFroms

getMainFroms: (venue: Venue) => Promise<Place[]>

Get the main froms for the specific venue

Type declaration

getMainSearches

getMainSearches: (venue: Venue) => Promise<MapwizeObject[]>

Get the main searches for the specific venue

Type declaration

getPlace

getPlace: (id: string) => Promise<Place>

Get a place using its id

Type declaration

    • (id: string): Promise<Place>

    • Parameters

      • id: string

      Returns Promise<Place>

getPlaceDetails

getPlaceDetails: (id: string) => Promise<PlaceDetails>

Get a place details using the place id

Type declaration

getPlaceWithAlias

getPlaceWithAlias: (alias: string, venue: Venue) => Promise<Place>

Get a place using its alias. As a place alias is only unique in a specific venue, you have to pass this venue as parameter

Type declaration

    • Parameters

      • alias: string
      • venue: Venue

      Returns Promise<Place>

getPlaceWithName

getPlaceWithName: (name: string, venue: Venue) => Promise<Place>

Get a place using its name. As a place name is only unique in a specific venue, you have to pass this venue as parameter

Type declaration

    • Parameters

      • name: string
      • venue: Venue

      Returns Promise<Place>

getPlacelist

getPlacelist: (id: string) => Promise<Placelist>

Get a placelist using its id

Type declaration

getPlacelistWithAlias

getPlacelistWithAlias: (alias: string, venue: Venue) => Promise<Placelist>

Get a placelist using its alias. As a placelist alias is only unique in a specific venue, you have to pass this venue as parameter

Type declaration

getPlacelistWithName

getPlacelistWithName: (name: string, venue: Venue) => Promise<Placelist>

Get a placelist using its name. As a placelist name is only unique in a specific venue, you have to pass this venue as parameter

Type declaration

getPlacelists

getPlacelists: (filter: ApiFilter) => Promise<Placelist[]>

Get all the placelists that match the ApiFilter

Type declaration

getPlaces

getPlaces: (params: ApiFilter) => Promise<Place[]>

Get all the places that match the ApiFilter

Type declaration

getPlacesForPlacelist

getPlacesForPlacelist: (placelist: Placelist) => Promise<Place[]>

Get all places contained in the placelist

Type declaration

getVenue

getVenue: (id: string) => Promise<Venue>

Get a venue using its id

Type declaration

    • (id: string): Promise<Venue>

    • Parameters

      • id: string

      Returns Promise<Venue>

getVenueWithAlias

getVenueWithAlias: (alias: string) => Promise<Venue>

Get a venue using its alias

Type declaration

    • (alias: string): Promise<Venue>

    • Parameters

      • alias: string

      Returns Promise<Venue>

getVenueWithName

getVenueWithName: (name: string) => Promise<Venue>

Get a venue using its name

Type declaration

    • (name: string): Promise<Venue>

    • Parameters

      • name: string

      Returns Promise<Venue>

getVenues

getVenues: (filter: ApiFilter) => Promise<Venue[]>

Get all venue that match the ApiFilter

Type declaration

search

search: (searchParams: SearchParams) => Promise<MapwizeObject[]>

Get search result using the SearchParams

Type declaration

setCookie

setCookie: (setCookie: string) => Promise<boolean>

set Cookie for Mapwize API

Type declaration

    • (setCookie: string): Promise<boolean>

    • a Set-Cookie HTTP header value

      Parameters

      • setCookie: string

      Returns Promise<boolean>

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Inherited property

Generated using TypeDoc