Classes Reference


                    
                    
                    SITCircularArea

A circle with center and radius

Declaration

Objective-C

@interface SITCircularArea : SITArea

Swift

class SITCircularArea : SITArea


                    
                    
                    SITEvent

An event: POI with radius, conversion area and asociated statistics. It is intended for usage in marketing apps

Declaration

Objective-C

@interface SITEvent : NSObject

Swift

class SITEvent : NSObject


                    
                    
                    SITCustomField

A Key-value structure to store information

Declaration

Objective-C

@interface SITCustomField : NSObject

Swift

class SITCustomField : NSObject


                    
                    
                    SITPOIBase

Base interface for SITPOI

Declaration

Objective-C

@interface SITPOIBase : NSObject

Swift

class SITPOIBase : NSObject


                    
                    
                    SITOccurrence

Describes importante situations around events

Declaration

Objective-C

@interface SITOccurrence : SITAPIBaseModel

Swift

class SITOccurrence : SITAPIBaseModel


                    
                    
                    SITBeaconFilter

The purpose of this class is to hold information of custom uuids

Declaration

Objective-C

@interface SITBeaconFilter : NSObject

Swift

class SITBeaconFilter : NSObject


                    
                    
                    SITFloorResource

A floor resource with building identifier and floor identifier

Declaration

Objective-C

@interface SITFloorResource : SITBuildingResource

Swift

class SITFloorResource : SITBuildingResource


                    
                    
                    SITMultilanguageString

A string with a different value depending of the language. ISO 639-2 is used to identify the languages.

See

ISO3Language

Declaration

Objective-C

@interface SITMultilanguageString : NSObject

Swift

class SITMultilanguageString : NSObject


                    
                    
                    SITURL

Abstraction of URL. Unifies management of both absolutes and relatives URLs.

Declaration

Objective-C

@interface SITURL : NSObject

Swift

class SITURL : NSObject


                    
                    
                    SITCommunicationManager

The Communication manager allows you to make asynchronous requests to the server, mostly to fetch data.

Declaration

Objective-C

@interface SITCommunicationManager : NSObject

Swift

class SITCommunicationManager : NSObject


                    
                    
                    SITDirectionsManager

Central component that provides guidances and routes to travel from a SITLocation or SITPoint to a destination place. Currently only works for route inside indoor areas.

Declaration

Objective-C

@interface SITDirectionsManager : NSObject <SITDirectionsInterface>

Swift

class SITDirectionsManager : NSObject, SITDirectionsInterface


                    
                    
                    SITDirectionsRequest

Parameters to request a route with SITDirectionsManager.

Declaration

Objective-C

@interface SITDirectionsRequest : NSObject

Swift

class SITDirectionsRequest : NSObject


                    
                    
                    SITGeofence

Class containing information about a geofence

Declaration

Objective-C

@interface SITGeofence : SITResource

Swift

class SITGeofence : SITResource


                    
                    
                    SITGeofenceBuilder

Class used to construct geofences

Declaration

Objective-C

@interface SITGeofenceBuilder : SITResource

Swift

class SITGeofenceBuilder : SITResource


                    
                    
                    SITCoordinateConverter

Utility class to convert between cartesian coordinates and geographical coordinates.

Declaration

Objective-C

@interface SITCoordinateConverter : NSObject

Swift

class SITCoordinateConverter : NSObject


                    
                    
                    SITLocation

Describes a geographical position of the user, either indoor or outdoor. A valid indoor location has floorIdentifier and cartesianCoordinate in its position property.

Declaration

Objective-C

@interface SITLocation : NSObject <NSCopying>

Swift

class SITLocation : NSObject, NSCopying


                    
                    
                    SITLocationManager

SITLocationManager The SITLocationManager class is the central point for configuring the delivery of location- and headind related events to your app. You use the shared instance of this class to establish the parameters that determine when location and heading events should be delivered and to start and stop the actual delivery of those events.

Set delegate to listen for location updates.

Note

This class needs bluetooth information to do its work. In case bluetooth access is off, or permissions are denied, an error will be returned to the delegate. It can be thrown at the initial checking or at any moment during the positioning.

Declaration

Objective-C

@interface SITLocationManager : NSObject <SITLocationInterface>

Swift

class SITLocationManager : NSObject, SITLocationInterface


                    
                    
                    SITLocationParametersUpdate

Data structure that stores information about changes in parameters of the location system that will be performed on the fly.

Declaration

Objective-C

@interface SITLocationParametersUpdate : NSObject

Swift

class SITLocationParametersUpdate : NSObject


                    
                    
                    SITLocationRequest

A data object that contains parameters for the location service (SITLocationManager)

Declaration

Objective-C

@interface SITLocationRequest : NSObject <NSCopying>

Swift

class SITLocationRequest : NSObject, NSCopying


                    
                    
                    SITAngle

Representation of an angle.

Declaration

Objective-C

@interface SITAngle : NSObject

Swift

class SITAngle : NSObject


                    
                    
                    SITBuilding

Provides information about the places where indoor location is supported.

Declaration

Objective-C

@interface SITBuilding : SITResource

Swift

class SITBuilding : SITResource


                    
                    
                    SITBuildingInfo

A building and its dependencies: floors, POIs and events

Declaration

Objective-C

@interface SITBuildingInfo : NSObject

Swift

class SITBuildingInfo : NSObject


                    
                    
                    SITBuildingResource

Resource that has a one-to-one relationship with a SITBuilding.

Declaration

Objective-C

@interface SITBuildingResource : SITResource

Swift

class SITBuildingResource : SITResource


                    
                    
                    SITCartesianCoordinate

A structure that contains cartesian coordinate.

Declaration

Objective-C

@interface SITCartesianCoordinate : NSObject

Swift

class SITCartesianCoordinate : NSObject


                    
                    
                    SITDimensions

Define 2D dimensions of a rectangular area.

Declaration

Objective-C

@interface SITDimensions : NSObject

Swift

class SITDimensions : NSObject


                    
                    
                    SITFloor

Floor of a building.

Declaration

Objective-C

@interface SITFloor : SITBuildingResource

Swift

class SITFloor : SITBuildingResource


                    
                    
                    SITPOICategory

It represents the types of POI

Declaration

Objective-C

@interface SITPOICategory : SITResource

Swift

class SITPOICategory : SITResource


                    
                    
                    SITPoint

Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.

Declaration

Objective-C

@interface SITPoint : NSObject

Swift

class SITPoint : NSObject


                    
                    
                    SITResource

Abstract base class with common properties across Resources

Declaration

Objective-C

@interface SITResource : NSObject

Swift

class SITResource : NSObject


                    
                    
                    SITIndication

Represents the instruction that a user should follow when on a SITRouteStep to continue the route.

Declaration

Objective-C

@interface SITIndication : NSObject

Swift

class SITIndication : NSObject


                    
                    
                    SITRoute

Route between two points. From and destination must be inside the same building.

Declaration

Objective-C

@interface SITRoute : NSObject

Swift

class SITRoute : NSObject


                    
                    
                    SITRouteSegment

A continuous segment of a route that contains points of the same floor

Declaration

Objective-C

@interface SITRouteSegment : NSObject

Swift

class SITRouteSegment : NSObject


                    
                    
                    SITRouteStep

A fragment of a route, described by an initial SITPoint (from) and a destination SITPoint (to). It also includes additional information about the fragment.

Declaration

Objective-C

@interface SITRouteStep : NSObject

Swift

class SITRouteStep : NSObject


                    
                    
                    SITOrganizationTheme

Class to represents different parameters to adapt the look and feel of an organization. To get all these parameters you must have selected the Tracking Package (https://dashboard.situm.es/accounts/register)

Declaration

Objective-C

@interface SITOrganizationTheme : SITResource

Swift

class SITOrganizationTheme : SITResource


                    
                    
                    SITThemeColors

Class the stores color definitions in hexadecimal to adapt the look and feel of your app. As a developer you can change these colors on the folowing link https://dashboard.situm.es/organization/theme

Declaration

Objective-C

@interface SITThemeColors : NSObject

Swift

class SITThemeColors : NSObject


                    
                    
                    SITRealTimeData

A data object that provides information about the location of users in real time

Declaration

Objective-C

@interface SITRealTimeData : NSObject

Swift

class SITRealTimeData : NSObject


                    
                    
                    SITNavigationManager

Default implementation of SITNavigationInterface

Declaration

Objective-C

@interface SITNavigationManager : NSObject <SITNavigationInterface>

Swift

class SITNavigationManager : NSObject, SITNavigationInterface


                    
                    
                    SITNavigationProgress

It provides information of the progress of a user while following a route.

Declaration

Objective-C

@interface SITNavigationProgress : NSObject

Swift

class SITNavigationProgress : NSObject


                    
                    
                    SITNavigationRequest

Class that stores relevant information to request navigation updates.

Declaration

Objective-C

@interface SITNavigationRequest : NSObject

Swift

class SITNavigationRequest : NSObject


                    
                    
                    SITRealTimeManager

Central point for accessing the location of the users in real time

Declaration

Objective-C

@interface SITRealTimeManager : NSObject <SITRealTimeInterface>

Swift

class SITRealTimeManager : NSObject, SITRealTimeInterface


                    
                    
                    SITRealTimeRequest

A data object that contains parameters for the real time service (SITRealTimeManager)

Declaration

Objective-C

@interface SITRealTimeRequest : NSObject

Swift

class SITRealTimeRequest : NSObject


                    
                    
                    SITOutdoorLocationOptions

Outdoor location options used only in indoor-outdoor mode

Declaration

Objective-C

@interface SITOutdoorLocationOptions : NSObject <NSCopying>

Swift

class SITOutdoorLocationOptions : NSObject, NSCopying


                    
                    
                    SITPOI

This class represents a Point Of Interest inside a SITBuilding

See

See SITPOIBase to check base properties

Declaration

Objective-C

@interface SITPOI : SITBuildingResource

Swift

class SITPOI : SITBuildingResource


                    
                    
                    SITServices

Service class for the Situm SDK for iOS

Declaration

Objective-C

@interface SITServices : NSObject

Swift

class SITServices : NSObject


                    
                    
                    SitumSDK

Base interface that imports all the public headers

Declaration

Objective-C

@interface SitumSDK : NSObject

Swift

class SitumSDK : NSObject