RSDK

The RSDK class provides a centralized point of control and coordination for interfacing with Ray beacons.

RaySDK delegate

  • The RaySDK delegate

    Declaration

    Swift

    public weak var delegate: RaySDKDelegate?

Config variables

  • The value where a beacon should be registered as in-range

    Default value is -75

    Declaration

    Swift

    public var beaconRSSITrigger: Int

  • The minimum value of the range where the beacon should stay in in-order to be considered in-range

    Value must be less than beaconMaximumThreshold and within range of (∞, 0)

    Default value is -80

    Declaration

    Swift

    public var beaconMinimumThreshold: Int

  • The maximum value of the range where the beacon should stay in in-order to be considered in-range

    Value must be greater than beaconMinimumThreshold and within range of (∞, 0]

    Default value is 0

    Declaration

    Swift

    public var beaconMaximumThreshold: Int

  • The value where a beacon should be registered as out-of-range

    Value must be less than beaconMinimumThreshold

    Default value is -90

    Declaration

    Swift

    public var beaconExitTrigger: Int

  • The time to wait (seconds) before a beacon is registered when entering its region

    Default value is 10 seconds

    Declaration

    Swift

    public var walkInTimeToWait: NSTimeInterval

  • The time to wait (seconds) before a beacon is registered when exiting its region

    Default value is 10 seconds

    Declaration

    Swift

    public var walkOutTimeToWait: NSTimeInterval

  • The time to wait (seconds) between identifying identical beacons

    Default value is 6 hours

    Declaration

    Swift

    public var subsequentRangingInterval: NSTimeInterval

  • If true, background process time will be extended while app is in background

    Default value is false

    Declaration

    Swift

    public var enableBackgroundProcessTimeExtension: Bool

  • If true, rsdkDidRangeRayBeacon:inRegionWithIdentifier: will continuously return all ranged beacons. Avoid continuous ranging to conserve battery.

    Default value is false

    Declaration

    Swift

    public var enableContinuousRanging: Bool

  • If true, rsdkDidWalkOutOfBeacon:inRegionWithIdentifier: will adhere to beaconExitTrigger and walkOutTimeToWait values.

    enableContinuousRanging must be set to true

    Default value is false

    Declaration

    Swift

    public var enableCustomWalkOut: Bool

Initializers & Deinitializer

  • Initializes a RSDK instance with the api key

    Declaration

    Swift

    public class func sharedInstanceWithApiKey(apiKey: String)

    Parameters

    apiKey

    The api key for making Ray requests

  • Returns the RaySDK singleton instance

    Declaration

    Swift

    public class var sharedInstance: RSDK

    Return Value

    The RaySDK instance created in RSDK

Monitoring methods

  • Starts monitoring for Ray beacons.

    If location services authorization has not been requested, will attempt to request if status is NotDetermined

    Declaration

    Swift

    public func startMonitoring()

  • Stops monitoring for Ray beacons.

    Declaration

    Swift

    public func stopMonitoring()

  • Start ranging for all monitored regions

    Declaration

    Swift

    public func startRanging()

  • Stop ranging for all currently ranged regions

    Declaration

    Swift

    public func stopRanging()

  • Sets the location service authorization request

    • Always
    • WhenInUse (Default)

    Declaration

    Swift

    public func setAuthorizationType(type: AuthorizationType)

    Parameters

    authorizationType

    The authorization type to request