OYMGoIndoor Class Reference

Inherits from NSObject
Declared in OYMGoIndoor.h
OYMGoIndoor.m

Other Methods

+ goIndoorWithBlock:

Creates a OYMGoIndoor Object with the arguments supplied to this GoIndoorBuilder.

+ (OYMGoIndoor *)goIndoorWithBlock:(void ( ^ ) ( id<GoIndoorBuilder> builder ))block

Return Value

A OYMGoIndoor object

Declared In

OYMGoIndoor.h

– disconnect

This method will disconnect the location provider and closes the session to the server.

- (void)disconnect

Declared In

OYMGoIndoor.h

– startLocate:

Method to start the Goindoor location with the default rate.

- (void)startLocate:(id<OYMLocationDelegate>)_delegate

Parameters

br

OYMLocationBroadcast to handle the output from the library

Declared In

OYMGoIndoor.h

– stopLocate

Method to stop the Goindoor location

- (void)stopLocate

Declared In

OYMGoIndoor.h

– computeRouteFrom:to:

This method computes a route between two given points.

- (OYMRoute *)computeRouteFrom:(OYMRoutePoint *)start to:(OYMRoutePoint *)destination

Parameters

start

Departure point

destination

Destination point

Return Value

A OYMRoute object describing the route between the given points

Declared In

OYMGoIndoor.h

– getLogger

Getter for the logger object. It can be used to log position and routes in the server.

- (OYMLogger *)getLogger

Return Value

The OYMLogger object

Declared In

OYMGoIndoor.h

– getBeacons

Getter for the beacon list.

- (NS_ARRAY_OF ( OYMBeacon *) *)getBeacons

Return Value

Returns The beacons list

Declared In

OYMGoIndoor.h

– getBeacon:

Getter for the beacon list.

- (NS_ARRAY_OF ( OYMBeacon *) *)getBeacon:(NSString *)identifier

Parameters

identifier

Building or floor ID whose beacons need to be retrieved

Return Value

Returns The beacons list

Declared In

OYMGoIndoor.h

– getBeacons:

Getter for the beacon list.

- (NS_ARRAY_OF ( OYMBeacon *) *)getBeacons:(NSArray *)identifiers

Parameters

identifiers

Building or floor IDs whose beacons need to be retrieved

Return Value

Returns The beacons list

Declared In

OYMGoIndoor.h

– getBuildings

Getter for the building list.

- (NS_ARRAY_OF ( OYMBuilding *) *)getBuildings

Return Value

Returns The buildings list

Declared In

OYMGoIndoor.h

– getBuilding:

Getter for the building list.

- (OYMBuilding *)getBuilding:(NSString *)identifier

Parameters

identifier

Building ID to be retrieved

Return Value

Returns The buildings list

Declared In

OYMGoIndoor.h

– getBuildings:

Getter for the building list.

- (NS_ARRAY_OF ( OYMBuilding *) *)getBuildings:(NSArray *)identifiers

Parameters

identifiers

Building IDs to be retrieved

Return Value

Returns The buildings list

Declared In

OYMGoIndoor.h

– getAssets

Getter for the asset list.

- (NS_ARRAY_OF ( OYMAsset *) *)getAssets

Return Value

Returns The asset list

Declared In

OYMGoIndoor.h

– getAsset:

Getter for the asset list.

- (NS_ARRAY_OF ( OYMAsset *) *)getAsset:(NSString *)identifier

Parameters

identifiers

Building or floor ID whose assets need to be retrieved

Return Value

Returns The assets list

Declared In

OYMGoIndoor.h

– getAssets:

Getter for the asset list.

- (NS_ARRAY_OF ( OYMAsset *) *)getAssets:(NSArray *)identifiers

Parameters

identifiers

Building or floor IDs whose assets need to be retrieved

Return Value

Returns The assets list

Declared In

OYMGoIndoor.h

– getPlaces

Getter for the places list.

- (NS_ARRAY_OF ( OYMPlace *) *)getPlaces

Return Value

Returns The places list

Declared In

OYMGoIndoor.h

– getPlaceWithIdentifier:

Getter for a place.

- (OYMPlace *)getPlaceWithIdentifier:(NSString *)identifier

Return Value

The place if it exists, it can be nil

Declared In

OYMGoIndoor.h

– getPlace:

Getter for the places list.

- (NS_ARRAY_OF ( OYMPlace *) *)getPlace:(NSString *)identifier

Parameters

identifiers

Building or floor ID whose places need to be retrieved

Return Value

Returns The places list

Declared In

OYMGoIndoor.h

– getPlaces:

Getter for the building list.

- (NS_ARRAY_OF ( OYMPlace *) *)getPlaces:(NSArray *)identifiers

Parameters

identifiers

Building or floor IDs whose places need to be retrieved

Return Value

Returns The places list

Declared In

OYMGoIndoor.h

– getPlacesWithLocationResult:andRadius:andTags:andFilter:

Getter for places inside a defined place.

- (NS_ARRAY_OF ( OYMPlace *) *)getPlacesWithLocationResult:(OYMLocationResult *)loc andRadius:(int)radius andTags:(NSArray *)tags andFilter:(NSDictionary *)filter

Parameters

loc

Location whose places needs to be retrieved

radius

Radius from the location. If 0 it will returns the closest one

tags

List of POI tags that should match in the search, it can be nil

filter

Map of POI properties that should match in the search, it can be nil

Return Value

The place list satisfying the criteria, sorted by distance

Declared In

OYMGoIndoor.h

– getPlacesWithId:andTags:andFilter:

Getter for the place list.

- (NS_ARRAY_OF ( OYMPlace *) *)getPlacesWithId:(NSString *)_ID andTags:(NSArray *)tags andFilter:(NSDictionary *)filter

Parameters

_ID

Building or floor ID whose places need to be retrieved, it can be nil

tags

List of POI tags that should match in the search, it can be nil

filter

Map of POI properties that should match in the search, it can be nil

Return Value

The place list satisfying the criteria

Declared In

OYMGoIndoor.h

– getPlacesWithLatitude:andLongitude:andRadius:andFloorNumber:andBuilding:andTags:andFilter:

Getter for the place list.

- (NS_ARRAY_OF ( OYMPlace *) *)getPlacesWithLatitude:(double)latitude andLongitude:(double)longitude andRadius:(int)radius andFloorNumber:(int)floorNumber andBuilding:(NSString *)building andTags:(NSArray *)tags andFilter:(NSDictionary *)filter

Parameters

latitude

WGS84 latitude whose places needs to be retrieved

longitude

WGS84 longitude whose places needs to be retrieved

radius

Radius from the location. If 0 it will returns the closest one

floorNumber

Floor number whose places needs to be retrieved

building

Building ID whose places needs to be retrieved

tags

List of POI tags that should match in the search, it can be nil

filter

Map of POI properties that should match in the search, it can be nil

Return Value

The place list satisfying the criteria, sorted by distance

Declared In

OYMGoIndoor.h

– getNotifications

Getter for the notification list.

- (NS_ARRAY_OF ( OYMNotification *) *)getNotifications

Return Value

Returns The notifications list

Declared In

OYMGoIndoor.h

– getNotification:

Getter for the notification list.

- (NS_ARRAY_OF ( OYMNotification *) *)getNotification:(NSString *)identifier

Parameters

identifier

Building or floor ID whose notifications need to be retrieved

Return Value

Returns The notifications list

Declared In

OYMGoIndoor.h

– getNotifications:

Getter for the notification list.

- (NS_ARRAY_OF ( OYMNotification *) *)getNotifications:(NSArray *)identifiers

Parameters

identifiers

Building or floor IDs whose notifications need to be retrieved

Return Value

Returns The notifications list

Declared In

OYMGoIndoor.h

– getSettings

Getter for the settings.

- (OYMSettings *)getSettings

Return Value

The settings object

Declared In

OYMGoIndoor.h

– getUserProfile

Getter for the user profile.

- (OYMUserProfile *)getUserProfile

Return Value

The user profile

Declared In

OYMGoIndoor.h

– getProxiBeacons

Getter for the proxiBeacon list.

- (NS_ARRAY_OF ( OYMProxiBeacon *) *)getProxiBeacons

Return Value

The proxiBeacon list

Declared In

OYMGoIndoor.h

– getIndicator:

Getter for an indicator

- (OYMIndicator *)getIndicator:(NSString *)identifier

Return Value

The indicator if it exists, it can be nil

Declared In

OYMGoIndoor.h

– getCombinations

Getter for the combinations list.

- (NS_ARRAY_OF ( OYMCombination *) *)getCombinations

Return Value

The combination list

Declared In

OYMGoIndoor.h

– setLocationType:

Sets the positioning type. It overrides the value given in the builder.

- (void)setLocationType:(OYMGoIndoorLocationType)type

Parameters

type

Location type to be applied

Declared In

OYMGoIndoor.h

– setMinDistanceUpdate:

Sets the minimum distance that should change the location result to be updated.

- (void)setMinDistanceUpdate:(double)dist

Parameters

dist

Distance threshold

Declared In

OYMGoIndoor.h

– setUpdatePolicy:

Sets the update policy. It overrides the value given in the builder.

- (void)setUpdatePolicy:(OYMGoIndoorUpdate)policy

Parameters

policy

Update policy to be applied

Declared In

OYMGoIndoor.h

– triggerUpdate

Triggers an immediate update to the database. It assumes that the update policy is fulfilled.

- (void)triggerUpdate

Declared In

OYMGoIndoor.h

Other Methods

– initWithUrl:andUser:andAccount:andPassword:andLocationType:andLocationUpdate:andDebug:andUpdatePolicy:andUpdateTime:andCBOptions:andConnectCallBack:

Indoor constructor with reconnection.

- (instancetype)initWithUrl:(NSString *)_url andUser:(NSString *)_user andAccount:(NSString *)acc andPassword:(NSString *)pwd andLocationType:(OYMGoIndoorLocationType)_locationType andLocationUpdate:(long)_refresh andDebug:(BOOL)_debug andUpdatePolicy:(OYMGoIndoorUpdate)_policy andUpdateTime:(long)_updateTime andCBOptions:(NSDictionary<NSString*,id> *)options andConnectCallBack:(void ( ^ ) ( BOOL succeed , NSString *message ))_connectCallBack

Parameters

user

User profile

account

User account

password

Password

policy

Database update policy

updateTime

Database update time

type

Location type

callback

Callback to handle the login process

url

URL to the server

Declared In

OYMGoIndoor.m