IndoorMapDelegate Protocol Reference

Conforms to NSObject
Declared in IndoorMap.h

Overview

Delegates for the events on indoorMap object.

– IndoorMapLoaded:

Called after map loaded (Deprecated: use indoor: loaded: instead.)

- (void)IndoorMapLoaded:(nonnull id)sender

Parameters

sender

The mapview that was pressed

Discussion

Called after map loaded

Declared In

IndoorMap.h

– indoor:onLoaded:

Called after map loaded on screen

- (void)indoor:(nonnull id)sender onLoaded:(BOOL)isLoaded

Parameters

sender

the mapview that passed

isLoaded

true/false always return true

Discussion

Called after map loaded on screen

Declared In

IndoorMap.h

– indoor:onVenueError:

Called when something wrong while fetching venue information

- (void)indoor:(nonnull id)sender onVenueError:(nonnull NSError *)error

Parameters

sender

the mapview that passed

error

error detail

Discussion

Called when something wrong while fetching venue information

Declared In

IndoorMap.h

– indoor:didLongPressAtCoordinate:floor:

Called after a long-press gesture at a particular coordinate.

- (void)indoor:(nonnull id)mapView didLongPressAtCoordinate:(CLLocationCoordinate2D)coordinate floor:(int)level

Parameters

mapView

The mapview that was pressed.

coordinate

The location that was pressed.

level

The current level/floor on the mapview where the long-press gesture was triggered.

Discussion

Called after a long-press gesture at a particular coordinate.

Declared In

IndoorMap.h

– indoor:didTapAtCoordinate:floor:

Called after a tap gesture at a particular coordinate

- (void)indoor:(nonnull id)mapView didTapAtCoordinate:(CLLocationCoordinate2D)coordinate floor:(int)level

Parameters

mapView

The mapview that was tapped.

coordinate

The location that was tapped.

level

The current level/floor on the mapview where the tap gesture was triggered.

Discussion

Called after a tap gesture at a particular coordinate

Declared In

IndoorMap.h

– indoor:enterPromoZone:promotion:

Called after the user location is found in a geo-fenced promo zone.

- (void)indoor:(nonnull id)mapView enterPromoZone:(nonnull NSDictionary *)Zone promotion:(nonnull NSArray *)offers

Parameters

mapView

The mapview where the user location is found.

Zone

A dictionary of the geo-fenced zone.

offers

An array of offers found in the geo-fenced promo zone.

Discussion

Called after the user location is found in a geo-fenced promo zone.

Declared In

IndoorMap.h

– indoor:exitPromoZone:

Called after the user exits from a previously entered geo-fenced promo zone.

- (void)indoor:(nonnull id)mapView exitPromoZone:(nonnull NSDictionary *)Zone

Parameters

mapView

The mapview where the user location is found.

Zone

A dictionary of the geo-fenced zone from where the user made an exit.

Discussion

Called after the user exits from a previously entered geo-fenced promo zone.

Declared In

IndoorMap.h

– indoor:route:

Called after the application desires to display route between two points.

- (void)indoor:(nonnull id)mapView route:(nonnull NSArray *)routeList

Parameters

mapView

The mapview where the route will be drawn.

routeList

An array of geojson objects

Discussion

Called after the application desires to display route between two points.

Declared In

IndoorMap.h

– indoor:noRoute:

Called when search route failed to get route

- (void)indoor:(nonnull id)mapView noRoute:(nonnull NSArray *)routeList

Parameters

mapView

The mapview where the route will be drawn.

routeList

empty route list

Discussion

Called when search route failed to get route

Declared In

IndoorMap.h

– indoor:onNavigationError:

Called when search route function failed

- (void)indoor:(nonnull id)mapView onNavigationError:(nonnull NSError *)errorInfo

Parameters

mapView

The mapview where the route will be drawn.

errorInfo

Detail error description

Discussion

Called when search route function failed

Declared In

IndoorMap.h

– indoor:instruction:pathInfo:

Called when user wants turn by turn instructions.

- (void)indoor:(nonnull id)mapView instruction:(NSUInteger)pathIndex pathInfo:(nonnull NSDictionary *)routeInfo

Parameters

mapView

The mapview where the route for turn by turn is drawn.

pathIndex

The index of the area/section.

routeInfo

The area/section data

Discussion

Called when user wants turn by turn instructions.

Declared In

IndoorMap.h

– indoor:instruction:pathInfo:triggerByUserInteaction:

Called when user wants turn by turn instructions.

- (void)indoor:(nonnull id)mapView instruction:(NSUInteger)pathIndex pathInfo:(nonnull NSDictionary *)routeInfo triggerByUserInteaction:(BOOL)isByUser

Parameters

mapView

The mapview where the route for turn by turn is drawn.

pathIndex

The index of the area/section.

routeInfo

The area/section data

isByUser

Action trigger by User or internal.

Discussion

Called when user wants turn by turn instructions.

Declared In

IndoorMap.h

– indoor:groupIndexChanged:from:

Group index change with path

- (void)indoor:(nonnull id)mapView groupIndexChanged:(NSString *_Nullable)newGroupIndex from:(NSString *_Nullable)oldGroupIndex

Parameters

mapView

the view

newGroupIndex

new group index

oldGroupIndex

old group index

Discussion

Group index change with path

Declared In

IndoorMap.h

– indoor:reRouteWithLocation:floor:

Called when a user is in navigation mode and moves away from the drawn route.

- (void)indoor:(nonnull id)mapView reRouteWithLocation:(CLLocationCoordinate2D)coordinate floor:(int)level

Parameters

mapView

The mapview that caused the event to trigger.

coordinate

The current coordinates of the user’s position.

level

The level at which the user is currently present.

Discussion

Called when a user is in navigation mode and moves away from the drawn route.

Declared In

IndoorMap.h

– indoor:navigationInterrupted:

Called when navigation interupted by user

- (void)indoor:(nonnull id)mapView navigationInterrupted:(BOOL)coordinate

Parameters

mapView

The mapview that caused the event to trigger

coordinate

True/false always return true

Discussion

Called when navigation interupted by user

Declared In

IndoorMap.h

– indoor:onFloorChange:

Called when change in floor is detected.

- (void)indoor:(nonnull id)mapView onFloorChange:(int)level

Parameters

mapView

The mapview that caused the event to trigger.

level

The level of the floor change.

Discussion

Called when change in floor is detected.

Declared In

IndoorMap.h

– indoor:onFloorChange:triggerByUserInteaction:

Called when change in floor is detected.

- (void)indoor:(nonnull id)mapView onFloorChange:(int)level triggerByUserInteaction:(BOOL)isByUser

Parameters

mapView

The mapview that caused the event to trigger.

level

The level of the floor change

isByUser

detect trigger by user or not

Discussion

Called when change in floor is detected.

Declared In

IndoorMap.h

– indoor:onFloorTapRepeat:

Called after a double tap gesture is detected on floor selector.

- (void)indoor:(nonnull id)mapView onFloorTapRepeat:(int)level

Parameters

mapView

The map view where the double tap was detected

level

The level selected by the user.

Discussion

Called after a double tap gesture is detected on floor selector.

Declared In

IndoorMap.h

– indoor:activeFloorList:

Floor list of map

- (void)indoor:(nonnull id)mapView activeFloorList:(nonnull NSArray *)levels

Parameters

mapView

The mapview that caused the event to trigger.

levels

The NSArray of levels for the venue.

Discussion

Floor list of map

Declared In

IndoorMap.h

– indoor:onEnterFloorChangeRegion:

Called when the user location is detected in the geo-fenced area of an escalator or an elevator. Indicates floor change action.

- (void)indoor:(nonnull id)mapView onEnterFloorChangeRegion:(nonnull NSDictionary *)region

Parameters

mapView

mapView The mapview where the user location is found.

region

region A dictionary of the elevator/escalator found nearby the user’s location.

Discussion

Called when the user location is detected in the geo-fenced area of an escalator or an elevator. Indicates floor change action.

Declared In

IndoorMap.h

– indoor:onExitFloorChangeRegion:

Called when the user moves out of the geo-fenced region for elevators/escalators.

- (void)indoor:(nonnull id)mapView onExitFloorChangeRegion:(NSDictionary *_Nullable)region

Parameters

mapView

mapView The mapview where the user location is found.

region

region A dictionary of the elevator/escalator from where the user has made an exit.

Discussion

Called when the user moves out of the geo-fenced region for elevators/escalators.

Declared In

IndoorMap.h

– indoor:endNavigation:

Called when the user arrives at the destination in navigation mode.

- (void)indoor:(nonnull id)mapView endNavigation:(BOOL)navigationend

Parameters

mapView

The mapview

navigationend

YES if user is arriving near the destination.

Discussion

Called when the user arrives at the destination in navigation mode.

Declared In

IndoorMap.h

– indoor:navigationExited:

Called when user explicit exit navigation

- (void)indoor:(nonnull id)mapView navigationExited:(BOOL)navigationState

Parameters

mapView

The mapview

navigationState

True when user exit navigation

Discussion

Called when user explicit exit navigation

Declared In

IndoorMap.h

– indoor:endNavigation:destinationDirection:

Called when the user arrives at the destination in navigation mode.

- (void)indoor:(nonnull id)mapView endNavigation:(BOOL)navigationState destinationDirection:(DestinationDirection)atDirection

Parameters

mapView

The mapview

navigationState

YES if user is arriving near the destination.

atDirection

direction of destination.

Discussion

Called when the user arrives at the destination in navigation mode.

Declared In

IndoorMap.h

– indoor:markerInfoWindow:

Called when a marker is about to become selected and provides an optional custom info window to use for that marker if this method returns a UIView.

- (nonnull UIView *)indoor:(nonnull id)mapView markerInfoWindow:(NSString *_Nullable)title

Parameters

mapView

mapView The mapview where the marker window will be shown.

title

title The text to show on the marker window.

Return Value

The custom info window for the specified marker, or nil for default

Discussion

Called when a marker is about to become selected and provides an optional custom info window to use for that marker if this method returns a UIView.

Declared In

IndoorMap.h

– indoor:didTapInfoWindowOfMarker:

Called when a tap gesture is detected on the marker’s info window.

- (void)indoor:(nonnull id)mapView didTapInfoWindowOfMarker:(nonnull NSDictionary *)markerDetail

Parameters

mapView

The mapview where the marker is shown.

markerDetail

The marker’s user data.

Discussion

Called when a tap gesture is detected on the marker’s info window.

Declared In

IndoorMap.h

– indoor:onMapAtIdlePostion:

Description

- (void)indoor:(nonnull id)mapView onMapAtIdlePostion:(float)zoomlevel

Parameters

mapView

mapView description

zoomlevel

zoomlevel description

Discussion

Description

Declared In

IndoorMap.h

– indoor:onMapSlide:

Description

- (void)indoor:(nonnull id)mapView onMapSlide:(float)zoomlevel

Parameters

mapView

mapView description

zoomlevel

zoomlevel description

Discussion

Description

Declared In

IndoorMap.h

– indoor:buildingChange:heights:building:

Called when building changed

- (void)indoor:(nonnull id)mapView buildingChange:(NSArray *_Nullable)levelList heights:(NSArray *_Nullable)heightList building:(NSString *_Nullable)name

Parameters

mapView

mapView description

levelList

List of levels in building

heightList

List of height in building for each levels

name

building name

Discussion

Called when building changed

Declared In

IndoorMap.h

– indoor:onBuildingViewChange:

Called when building changed

- (void)indoor:(nonnull id)mapView onBuildingViewChange:(NSDictionary *_Nullable)buildinginfo

Parameters

mapView

The mapview where build changed

buildinginfo

more information about building

Discussion

Called when building changed

Declared In

IndoorMap.h

– indoor:showTextWithIcon:andText:basetext:

Showing labels on map

- (BOOL)indoor:(nonnull id)mapView showTextWithIcon:(UIImage *_Nullable *_Nullable)iconImage andText:(NSString *_Nullable *_Nullable)areaName basetext:(NSString *_Nullable)baseString

Parameters

mapView

The mapview where lables renders

iconImage

icon of lables

areaName

text on labels

baseString

english version of label

Return Value

True/False

Discussion

Showing labels on map

Declared In

IndoorMap.h

– indoor:customizeAreaName:andText:

Showing labels on map

- (UIView *_Nullable)indoor:(nonnull id)mapView customizeAreaName:(NSString *_Nullable)imageurl andText:(NSString *_Nullable)areaName

Parameters

mapView

The mapview where lables renders

imageurl

external image URL for label

areaName

Name of labels

Return Value

True/False

Discussion

Showing labels on map

Declared In

IndoorMap.h

– indoor:customizePOIPin:

Customize POI pin marker

- (UIView *_Nullable)indoor:(nonnull id)mapview customizePOIPin:(UIImage *_Nullable)imgPin

Parameters

mapview

The mapview where pin renders

imgPin

Image of pin from SDK

Return Value

UIView to render for marker

Discussion

Customize POI pin marker

Declared In

IndoorMap.h

– indoor:customizeStartMarker:

Customize start marker

- (UIView *_Nullable)indoor:(nonnull id)mapview customizeStartMarker:(UIImage *_Nullable)imgPin

Parameters

mapview

The mapview where start marker render

imgPin

image from SDK

Return Value

customize view for start marker

Discussion

Customize start marker

Declared In

IndoorMap.h

– indoor:customizeEndMarker:

Customize end marker

- (UIView *_Nullable)indoor:(nonnull id)mapview customizeEndMarker:(UIImage *_Nullable)imgPin

Parameters

mapview

The mapview where end marker render

imgPin

image from SDK

Return Value

customize view for end marker

Discussion

Customize end marker

Declared In

IndoorMap.h

– indoor:customizeLevelChangedMarker:movingUp:

Customize level changed marker

- (UIView *_Nullable)indoor:(nonnull id)mapview customizeLevelChangedMarker:(UIImage *_Nullable)imgPin movingUp:(BOOL)up

Parameters

mapview

The mapview where level marker render

imgPin

image from SDK

up

Moving up direction

Return Value

View to display on map

Discussion

Customize level changed marker

Declared In

IndoorMap.h

– indoor:customizeLevelChangedMarker:mode:movingUp:

Customize level changed marker

- (UIView *_Nullable)indoor:(nonnull id)mapview customizeLevelChangedMarker:(UIImage *_Nullable)imgPin mode:(FloorConntectedBy)floorChangeMode movingUp:(BOOL)up

Parameters

mapview

The mapview where level marker render

imgPin

image from SDK

floorChangeMode

floor change Using mode

up

Moving up direction

Return Value

View to display on map

Discussion

Customize level changed marker

Declared In

IndoorMap.h

– indoor:customizeLevelChangedMarker:movingUp:atStart:

Customize level changed marker

- (UIView *_Nullable)indoor:(nonnull id)mapview customizeLevelChangedMarker:(UIImage *_Nullable)imgPin movingUp:(BOOL)up atStart:(BOOL)nearStart

Parameters

mapview

The mapview where level marker render

imgPin

image from SDK

up

Moving up direction

nearStart

atstart point

Return Value

View to display on map

Discussion

Customize level changed marker

Declared In

IndoorMap.h

– indoor:onLevelChangedMarkerAnchor:

Anchor point where marker render default(.0,.5)

- (CGPoint)indoor:(nonnull id)mapview onLevelChangedMarkerAnchor:(CGPoint)refAnchor

Parameters

mapview

The mapview where level marker render

refAnchor

SDK marker point

Return Value

Changed marker point

Discussion

Anchor point where marker render default(.0,.5)

Declared In

IndoorMap.h

– indoor:customizeBuildingChangedMarker:building:

Customize building anchor

- (UIView *_Nullable)indoor:(nonnull id)mapview customizeBuildingChangedMarker:(UIImage *_Nullable)imgPin building:(NSString *_Nullable)buildingref

Parameters

mapview

The mapview where level marker render

imgPin

image from SDK

buildingref

building number

Return Value

view of building method

Discussion

Customize building anchor

Declared In

IndoorMap.h

– indoor:buildingChangedMarkerAnchor:

Customize building anchor

- (CGPoint)indoor:(nonnull id)mapview buildingChangedMarkerAnchor:(CGPoint)refAnchor

Parameters

mapview

The mapview where level marker render

refAnchor

anchore point set by sdk

Return Value

new Anchor point

Discussion

Customize building anchor

Declared In

IndoorMap.h

– indoor:onPOIFound:onFailed:

Called when poi searched on map

- (void)indoor:(nonnull id)mapView onPOIFound:(NSDictionary *_Nullable)poiinfo onFailed:(NSError *_Nullable)error

Parameters

mapView

The mapview where poi marker render

poiinfo

Detail of POI

error

return error when poi not found else nil

Discussion

Called when poi searched on map

Declared In

IndoorMap.h

– indoor:willMove:

Called before the camera on the map changes, either due to a gesture, animation (e.g., by a user tapping on the “My Location” button) or by being updated explicitly via the camera or a zero-length animation on layer.

- (void)indoor:(nonnull GMSMapView *)mapView willMove:(BOOL)gesture

Parameters

mapView

Google map Instance

gesture

If YES, this is occuring due to a user gesture.

Discussion

Called before the camera on the map changes, either due to a gesture, animation (e.g., by a user tapping on the “My Location” button) or by being updated explicitly via the camera or a zero-length animation on layer.

Declared In

IndoorMap.h

– indoor:didChangeCameraPosition:

Called repeatedly during any animations or gestures on the map (or once, if the camera is explicitly set). This may not be called for all intermediate camera positions. It is always called for the final position of an animation or gesture.

- (void)indoor:(nonnull GMSMapView *)mapView didChangeCameraPosition:(nonnull GMSCameraPosition *)position

Parameters

mapView

Google map Instance

position

Center location on map

Discussion

Called repeatedly during any animations or gestures on the map (or once, if the camera is explicitly set). This may not be called for all intermediate camera positions. It is always called for the final position of an animation or gesture.

Declared In

IndoorMap.h

– indoor:didChangeMapMode:

Called When map view mode changed by User

- (void)indoor:(nonnull id)mapView didChangeMapMode:(MapViewMode)previewMode

Parameters

mapView

map

previewMode

View mode Unknown/Center/heading

Discussion

Called When map view mode changed by User

Declared In

IndoorMap.h

– indoor:jumpsupress:atdistance:

Apply jump logic and handle jump supress event

- (void)indoor:(nonnull id)mapView jumpsupress:(CGIndoorMapPoint)jumppoint atdistance:(double)jumpdistance

Parameters

mapView

UI Map

jumppoint

location point for false reading

jumpdistance

distance of false reading

Discussion

Apply jump logic and handle jump supress event

Declared In

IndoorMap.h

– indoor:onSearchedPOISelected:

Area info for search poi

- (void)indoor:(nonnull id)mapview onSearchedPOISelected:(nullable NSDictionary *)poiinfo

Parameters

mapview

map view

poiinfo

more information about poi defined

Discussion

Area info for search poi

Declared In

IndoorMap.h

– indoor:onNavigationStatusUpdated:

called if user position changed while navigation node

- (void)indoor:(nonnull id)mapview onNavigationStatusUpdated:(nonnull NSDictionary *)navigationStatusUpdated

Parameters

mapview

map view

navigationStatusUpdated

more information Navigation time remaining in seconds, Distance to be covered in meters, walking speed

Discussion

called if user position changed while navigation node

Declared In

IndoorMap.h