Classes

The following classes are available globally.

  • A circle with center and radius

    See more

    Declaration

    Objective-C

    @interface SITCircularArea : SITArea <SITMapperProtocol>

    Swift

    class SITCircularArea : SITArea, SITMapperProtocol

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

    See more

    Declaration

    Objective-C

    @interface SITEvent : NSObject <SITMapperProtocol>

    Swift

    class SITEvent : NSObject, SITMapperProtocol

  • A Key-value structure to store information

    See more

    Declaration

    Objective-C

    @interface SITCustomField : NSObject

    Swift

    class SITCustomField : NSObject

  • Base interface for SITPOI

    See more

    Declaration

    Objective-C

    @interface SITPOIBase : NSObject

    Swift

    class SITPOIBase : NSObject

  • This class encapsulates all the objects that can be configured remotely using the dashboard. At the moment SITLocationRequest. You can use this class only to check the parameters that is being stored on the dashboard but as a developer you should not use objects of this class directly.

    See more

    Declaration

    Objective-C

    @interface SITRemoteConfig : SITResource

    Swift

    class SITRemoteConfig : SITResource

  • Describes importante situations around events

    See more

    Declaration

    Objective-C

    @interface SITOccurrence : SITAPIBaseModel

    Swift

    class SITOccurrence : SITAPIBaseModel

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

    See more

    Declaration

    Objective-C

    @interface SITBeaconFilter : NSObject

    Swift

    class SITBeaconFilter : NSObject

  • A floor resource with building identifier and floor identifier

    See more

    Declaration

    Objective-C

    @interface SITFloorResource : SITBuildingResource

    Swift

    class SITFloorResource : SITBuildingResource

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

    See

    ISO3Language
    See more

    Declaration

    Objective-C

    @interface SITMultilanguageString : NSObject

    Swift

    class SITMultilanguageString : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SITURL : NSObject

    Swift

    class SITURL : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SITCommunicationManager : NSObject

    Swift

    class SITCommunicationManager : NSObject

  • 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.

    See more

    Declaration

    Objective-C

    @interface SITDirectionsManager : NSObject <SITDirectionsInterface>

    Swift

    class SITDirectionsManager : NSObject, SITDirectionsInterface

  • Parameters to request a route with SITDirectionsManager.

    See more

    Declaration

    Objective-C

    @interface SITDirectionsRequest : NSObject <SITMapperProtocol>

    Swift

    class SITDirectionsRequest : NSObject, SITMapperProtocol

  • Class containing information about a geofence

    See more

    Declaration

    Objective-C

    @interface SITGeofence : SITResource

    Swift

    class SITGeofence : SITResource

  • Class used to construct geofences

    See more

    Declaration

    Objective-C

    @interface SITGeofenceBuilder : SITResource

    Swift

    class SITGeofenceBuilder : SITResource

  • Utility class to convert between cartesian coordinates and geographical coordinates.

    See more

    Declaration

    Objective-C

    @interface SITCoordinateConverter : NSObject

    Swift

    class SITCoordinateConverter : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SITLocation : NSObject <NSCopying, SITMapperProtocol>

    Swift

    class SITLocation : NSObject, NSCopying, SITMapperProtocol

  • 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 the desired delegates 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.
    See more

    Declaration

    Objective-C

    @interface SITLocationManager : NSObject <SITLocationInterface>

    Swift

    class SITLocationManager : NSObject, SITLocationInterface

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

    See more

    Declaration

    Objective-C

    @interface SITLocationParametersUpdate : NSObject

    Swift

    class SITLocationParametersUpdate : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SITLocationRequest : NSObject <NSCopying, SITMapperProtocol>

    Swift

    class SITLocationRequest : NSObject, NSCopying, SITMapperProtocol

  • This class allows to configure some parameters in order for the location engine to adjust the location of the user to a route while traveling at a close distance.

    See more

    Declaration

    Objective-C

    @interface SITRouteAdjustment : NSObject

    Swift

    class SITRouteAdjustment : NSObject

  • Representation of an angle.

    See more

    Declaration

    Objective-C

    @interface SITAngle : NSObject <SITMapperProtocol>

    Swift

    class SITAngle : NSObject, SITMapperProtocol

  • Provides information about the places where indoor location is supported.

    See more

    Declaration

    Objective-C

    @interface SITBuilding : SITResource

    Swift

    class SITBuilding : SITResource

  • A building and its dependencies: floors, POIs and events

    See more

    Declaration

    Objective-C

    @interface SITBuildingInfo : NSObject <SITMapperProtocol>

    Swift

    class SITBuildingInfo : NSObject, SITMapperProtocol

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

    See more

    Declaration

    Objective-C

    @interface SITBuildingResource : SITResource

    Swift

    class SITBuildingResource : SITResource

  • A structure that contains cartesian coordinate.

    See more

    Declaration

    Objective-C

    @interface SITCartesianCoordinate : NSObject <SITMapperProtocol>

    Swift

    class SITCartesianCoordinate : NSObject, SITMapperProtocol

  • Define 2D dimensions of a rectangular area.

    See more

    Declaration

    Objective-C

    @interface SITDimensions : NSObject <SITMapperProtocol>

    Swift

    class SITDimensions : NSObject, SITMapperProtocol

  • Floor of a building.

    See more

    Declaration

    Objective-C

    @interface SITFloor : SITBuildingResource

    Swift

    class SITFloor : SITBuildingResource

  • It represents the types of POI

    See more

    Declaration

    Objective-C

    @interface SITPOICategory : SITResource

    Swift

    class SITPOICategory : SITResource

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

    See more

    Declaration

    Objective-C

    @interface SITPoint : NSObject <SITMapperProtocol>

    Swift

    class SITPoint : NSObject, SITMapperProtocol

  • Abstract base class with common properties across Resources

    See more

    Declaration

    Objective-C

    @interface SITResource : NSObject <SITMapperProtocol>

    Swift

    class SITResource : NSObject, SITMapperProtocol

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

    See more

    Declaration

    Objective-C

    @interface SITIndication : NSObject <SITMapperProtocol>

    Swift

    class SITIndication : NSObject, SITMapperProtocol

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

    See more

    Declaration

    Objective-C

    @interface SITRoute : NSObject <SITMapperProtocol>

    Swift

    class SITRoute : NSObject, SITMapperProtocol

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

    See more

    Declaration

    Objective-C

    @interface SITRouteSegment : NSObject <SITMapperProtocol>

    Swift

    class SITRouteSegment : NSObject, SITMapperProtocol

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

    See more

    Declaration

    Objective-C

    @interface SITRouteStep : NSObject <SITMapperProtocol>

    Swift

    class SITRouteStep : NSObject, SITMapperProtocol

  • 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.com/accounts/register)

    See more

    Declaration

    Objective-C

    @interface SITOrganizationTheme : SITResource

    Swift

    class SITOrganizationTheme : SITResource

  • 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.com/organization/theme

    See more

    Declaration

    Objective-C

    @interface SITThemeColors : NSObject

    Swift

    class SITThemeColors : NSObject

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

    See more

    Declaration

    Objective-C

    @interface SITRealTimeData : NSObject

    Swift

    class SITRealTimeData : NSObject

  • Default implementation of SITNavigationInterface

    See more

    Declaration

    Objective-C

    @interface SITNavigationManager : NSObject <SITNavigationInterface>

    Swift

    class SITNavigationManager : NSObject, SITNavigationInterface

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

    See more

    Declaration

    Objective-C

    @interface SITNavigationProgress : NSObject <SITMapperProtocol>

    Swift

    class SITNavigationProgress : NSObject, SITMapperProtocol

  • Class that stores relevant information to request navigation updates.

    See more

    Declaration

    Objective-C

    @interface SITNavigationRequest : NSObject <SITMapperProtocol>

    Swift

    class SITNavigationRequest : NSObject, SITMapperProtocol

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

    See more

    Declaration

    Objective-C

    @interface SITRealTimeManager : NSObject <SITRealTimeInterface>

    Swift

    class SITRealTimeManager : NSObject, SITRealTimeInterface

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

    See more

    Declaration

    Objective-C

    @interface SITRealTimeRequest : NSObject <SITMapperProtocol>

    Swift

    class SITRealTimeRequest : NSObject, SITMapperProtocol

  • Describes a external location to be inyected to the sdk.

    See more

    Declaration

    Objective-C

    @interface SITExternalLocation : NSObject

    Swift

    class SITExternalLocation : NSObject

  • Outdoor location options used only in indoor-outdoor mode

    See more

    Declaration

    Objective-C

    @interface SITOutdoorLocationOptions : NSObject <NSCopying>

    Swift

    class SITOutdoorLocationOptions : NSObject, NSCopying

  • This class represents a Point Of Interest inside a SITBuilding

    See

    See SITPOIBase to check base properties
    See more

    Declaration

    Objective-C

    @interface SITPOI : SITBuildingResource

    Swift

    class SITPOI : SITBuildingResource

  • Service class for the Situm SDK for iOS

    See more

    Declaration

    Objective-C

    @interface SITServices : NSObject

    Swift

    class SITServices : NSObject

  • Representation of the floor map in tile that represents an image at zoom level with coordinates x, y

    See more

    Declaration

    Objective-C

    @interface SITTile : NSObject

    Swift

    class SITTile : NSObject

  • Class that displays the map of a buillding while allowing for some functionalities: Level selection, POI search, POI detail, …

    See more

    Declaration

    Objective-C

    @interface SITMapView : UIView

    Swift

    class SITMapView : UIView

  • Data class that stores values to configure a SITMapView instace.

    See more

    Declaration

    Objective-C

    @interface SITMapViewConfiguration : NSObject

    Swift

    class SITMapViewConfiguration : NSObject

  • Class that acts as a controller for SITMapView and manages user interactions and map data.

    See more

    Declaration

    Objective-C

    @interface SITMapViewController : NSObject

    Swift

    class SITMapViewController : NSObject

  • Class to map Situm enums to strings

    See more

    Declaration

    Objective-C

    @interface SITEnumMapper : NSObject

    Swift

    class SITEnumMapper : NSObject