ProximityRegion

@objc(UAProximityRegion)
public class ProximityRegion : NSObject

A proximity region defines an identifier, major and minor.

  • Default constructor.

    Declaration

    Swift

    public init?(
    proximityID: String,
    major: Double,
    minor: Double,
    rssi: Double? = nil,
    latitude: Double? = nil,
    longitude: Double? = nil
)

    Parameters

    proximityID

    The ID of the proximity region.
    major

    The major.
    minor

    The minor.
    rssi

    The rssi.
    latitude

    The latitude of the circular region’s center point in degrees.
    longitude

    The longitude of the circular region’s center point in degrees.

    Return Value

    Proximity region object or nil if error occurs.

  • Factory method for creating a proximity region.

    Declaration

    Swift

    @objc(proximityRegionWithID:major:minor:)
public class func proximityRegion(
    proximityID: String,
    major: Double,
    minor: Double
) -> ProximityRegion?

    Parameters

    proximityID

    The ID of the proximity region.
    major

    The major.
    minor

    The minor.

    Return Value

    Proximity region object or nil if error occurs.

  • Factory method for creating a proximity region.

    Declaration

    Swift

    @objc(proximityRegionWithID:major:minor:rssi:)
public class func proximityRegion(
    proximityID: String,
    major: Double,
    minor: Double,
    rssi: Double
) -> ProximityRegion?

    Parameters

    proximityID

    The ID of the proximity region.
    major

    The major.
    minor

    The minor.
    rssi

    The rssi.

    Return Value

    Proximity region object or nil if error occurs.

  • Factory method for creating a proximity region.

    Declaration

    Swift

    @objc(proximityRegionWithID:major:minor:latitude:longitude:)
public class func proximityRegion(
    proximityID: String,
    major: Double,
    minor: Double,
    latitude: Double,
    longitude: Double
) -> ProximityRegion?

    Parameters

    proximityID

    The ID of the proximity region.
    major

    The major.
    minor

    The minor.
    latitude

    The latitude of the circular region’s center point in degrees.
    longitude

    The longitude of the circular region’s center point in degrees.

    Return Value

    Proximity region object or nil if error occurs.

  • Factory method for creating a proximity region.

    Declaration

    Swift

    @objc(proximityRegionWithID:major:minor:rssi:latitude:longitude:)
public class func proximityRegion(
    proximityID: String,
    major: Double,
    minor: Double,
    rssi: Double,
    latitude: Double,
    longitude: Double
) -> ProximityRegion?

    Parameters

    proximityID

    The ID of the proximity region.
    major

    The major.
    minor

    The minor.
    rssi

    The rssi.
    latitude

    The latitude of the circular region’s center point in degrees.
    longitude

    The longitude of the circular region’s center point in degrees.

    Return Value

    Proximity region object or nil if error occurs.