SITGeofenceBuilder

Objective-C

@interface SITGeofenceBuilder : SITResource

Swift

class SITGeofenceBuilder : SITResource

Class used to construct geofences

  • This method creates a geofence with the info provided

    Declaration

    Objective-C

    - (SITGeofence *_Nonnull)build;

    Swift

    func build() -> SITGeofence

    Return Value

    An instance of the class geofence

  • Adds a base geofence to the builder

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithGeofence:(SITGeofence *_Nonnull)geofence;

    Swift

    init(geofence: SITGeofence)

    Parameters

    geofence

    Instance of the class geofence

    Return Value

    Initialized builder

  • Add name info to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)name:(NSString *_Nonnull)name;

    Swift

    func name(_ name: String) -> SITGeofenceBuilder

    Parameters

    name

    Name info to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add code info to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)code:(NSString *_Nonnull)code;

    Swift

    func code(_ code: String) -> SITGeofenceBuilder

    Parameters

    Code

    info to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add description info to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)description:(NSString *_Nonnull)description;

    Swift

    func description(_ description: String) -> SITGeofenceBuilder

    Parameters

    Description

    info to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add additional information in html format to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)infoHtml:(NSString *_Nonnull)infoHtml;

    Swift

    func infoHtml(_ infoHtml: String) -> SITGeofenceBuilder

    Parameters

    infoHtml

    info to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add floorId info to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)floorIdentifier:
        (NSString *_Nonnull)floorIdentifier;

    Swift

    func floorIdentifier(_ floorIdentifier: String) -> SITGeofenceBuilder

    Parameters

    Floor

    Id info to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add name buildingId to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)buildingIdentifier:
        (NSString *_Nonnull)buildingIdentifier;

    Swift

    func buildingIdentifier(_ buildingIdentifier: String) -> SITGeofenceBuilder

    Parameters

    Building

    Id info to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add points array to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)polygonPoints:
        (NSArray<SITPoint *> *_Nonnull)polygonPoints;

    Swift

    func polygonPoints(_ polygonPoints: [SITPoint]) -> SITGeofenceBuilder

    Parameters

    Points

    array to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add identifier info to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)identifier:(NSString *_Nonnull)identifier;

    Swift

    func identifier(_ identifier: String) -> SITGeofenceBuilder

    Parameters

    Identifier

    info to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add creation date info to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)createdAt:(NSDate *_Nonnull)createdAt;

    Swift

    func created(at createdAt: Date) -> SITGeofenceBuilder

    Parameters

    Info

    about the creation date to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add update date info to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)updatedAt:(NSDate *_Nonnull)updatedAt;

    Swift

    func updated(at updatedAt: Date) -> SITGeofenceBuilder

    Parameters

    Info

    about the update date to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called

  • Add custom fields array to the builder

    Declaration

    Objective-C

    - (SITGeofenceBuilder *_Nonnull)customFields:
        (NSDictionary *_Nonnull)customFields;

    Swift

    func customFields(_ customFields: [AnyHashable : Any]) -> SITGeofenceBuilder

    Parameters

    Custom

    fields array to be added to the builder

    Return Value

    The same instance of the builder upon which this method was called