FintivSkin

Contents

public class FintivSkin : NSObject

A Fintiv Skin object, used to skin UI Elements of an app

Properties

description 
override public var description: String

Human readable description of the skin

hash 
override public var hash: Int

Hashable protocol comformance

Methods

init(withBundledSkin:skinType:) 
public convenience init?(withBundledSkin named : String,  skinType : SkinType)

Initializes a skin given a bundled skin json file

  • Parameters:
    • named: Named of the file in main bundle containing the json-formatted skin definition
    • skinType: The Type of the skin being created

Parameters

Name Description
named Named of the file in main bundle containing the json-formatted skin definition
skinType The Type of the skin being created
init(withData:skinType:) 
public init?(withData data : Data?,  skinType : SkinType)

Initializes a skin given the Data representation of a skin

  • Parameters:
    • data: data representation of a skin
    • skinType: The Type of the skin being created

Parameters

Name Description
data data representation of a skin
skinType The Type of the skin being created
init(withLocalSkin:) 
public init?(withLocalSkin skinType : SkinType?)

Convenience initializer of a skin for a given skin type

ONLY use if main bundle contains a skindef_default.json file

  • Parameter skinType: The Type of the skin being created

Parameters

Name Description
skinType The Type of the skin being created

SkinBeaconMonitorFilter

Contents

public class SkinBeaconMonitorFilter : NSObject

A Skin Beacon Monitor Filter

Methods

filterByRSSI(minimumSignal:) 
public static func filterByRSSI(minimumSignal signal : Int) -> SkinBeaconMonitorFilter

Returns a beacon monitoring filter by signal strength

  • Parameter signal: mininum signal stregth of the beacon to monitor for
  • Returns: A Skin Beacon Monitor Filter

Parameters

Name Description
signal mininum signal stregth of the beacon to monitor for
filterByCoreLocationProximity(proximity:) 
public static func filterByCoreLocationProximity(proximity : CLProximity) -> SkinBeaconMonitorFilter

Returns a beacon monitoring filter by CoreLocation proximity

  • Parameter proximity: the minimum CoreLocation proximty level to account monitor beacons for
  • Returns: A Skin Beacon Monitor Filter

Parameters

Name Description
proximity the minimum CoreLocation proximty level to account monitor beacons for

SkinBeaconRegion

Contents

public class SkinBeaconRegion : NSObject, NSCoding

Object representing a Skin Region to monitor

Methods

encode(with:) 
public func encode(with aCoder: NSCoder)

NSCoding protocol comformance

init(coder:) 
public required init?(coder aDecoder: NSCoder)

NSCoding protocol comformance - Do not call directly

beaconRegionWith(uuidString:regionName:major:minor:) 
public static func beaconRegionWith(uuidString uuid : String, regionName : String?, major: Int, minor: Int) -> SkinBeaconRegion

Returns a SkinBeaconRegion object

  • Parameters:
    • uuid: the advertisement uuid of the beacon
    • regionName: optional region name for the beacon
    • major: the major integer number of the beacon region
    • minor: the minor integer number of the beacon region
  • Returns: a SkinBeaconRegion

Parameters

Name Description
uuid the advertisement uuid of the beacon
regionName optional region name for the beacon
major the major integer number of the beacon region
minor the minor integer number of the beacon region
init(identifier:regionName:major:minor:) 
public init(identifier : String, regionName : String?, major : Int?, minor : Int?)

Initializes a SkinBeaconRegion

  • Parameters:
    • identifier: the advertisement uuid of the beacon
    • regionName: optional region name for the beacon
    • major: the major integer number of the beacon region
    • minor: the minor integer number of the beacon region

Parameters

Name Description
identifier the advertisement uuid of the beacon
regionName optional region name for the beacon
major the major integer number of the beacon region
minor the minor integer number of the beacon region
asBeaconRegion() 
public func asBeaconRegion() -> CLBeaconRegion?

Return a CoreLocation Beacon Region version of the SkinBeaconRegion

  • Returns: CoreLocation Beacon Region version of the Skin Beacon Region

SkinObjectIdentifierMap

Contents

public class SkinObjectIdentifierMap: NSObject

The Object Identifier map, wrapper around a [String : String] dictionary that matches [UIView.accessibilityIdentifier : objectJson key from the skin payload]

Methods

init(withMap:) 
public init(withMap map : [String : String])

Inits an object identifier map

  • Parameter map: a [AccessibilityIdentifier : Json Key] map

Parameters

Name Description
map a [AccessibilityIdentifier : Json Key] map
setIdentiferToJsonKeyMap(_:) 
public func setIdentiferToJsonKeyMap(_ map : [String : String])

Sets a new object identifier map to use when applying a new skin

  • Parameter map: new [AccessibilityIdentifier : Json Key] map

Parameters

Name Description
map new [AccessibilityIdentifier : Json Key] map
defaultObjectIdentifierToKeyMap() 
public static func defaultObjectIdentifierToKeyMap() -> SkinObjectIdentifierMap

A default object map as used by Fintiv’s reseller app

  • Returns: object identifier map

SkinServicePropertyMap

Contents

public class SkinServicePropertyMap : NSObject

The Property identifier map, wrapper around a [String : String] dictionary that matches the [jsonKey : Key-Value-Coding key] to parse & apply properties for.

Methods

init(withMap:) 
public init(withMap map : [String : String])

Initializes the map from an explicit [skin jsonKey : Key-Value-Coding key] ([String : String]) dictionary

  • Parameter map: the [skin JsonKey : Key-Value-Coding key] dictionary to use for property mapping

Parameters

Name Description
map the [skin JsonKey : Key-Value-Coding key] dictionary to use for property mapping
setJsonPropertyKeyToKeyValue(_:) 
public func setJsonPropertyKeyToKeyValue(_ map : [String : String])

Sets the current property skin to use when skinning UI elements

  • Parameter map: the [skin JsonKey : Key-Value-Coding key] dictionary to use for property mapping

Parameters

Name Description
map the [skin JsonKey : Key-Value-Coding key] dictionary to use for property mapping
defaultJsonPropertyKeyToKeyValueMap() 
public static func defaultJsonPropertyKeyToKeyValueMap() -> SkinServicePropertyMap

Convenience method for default property skin map. Used for Fintiv’s unbranded app

  • Returns: a property map as used by Fintiv’s app