BKResolveData

open class BKResolveData: NSObject, NSSecureCoding

Read only data object for resolved output data of the blukii info manager

BKResolveData can be valid for blukii modules only.

It contains the result of a data request to the blukii Info Manager (https://manager.blukiiinfo.com). The BKResolveData fields contain the values of on corresponding blukii number.

BKResolveData is part of BKOutputElement

It will be set for the following cases:

  • OutputElement ID (see BKOutputElement.id) must be configured as a blukii number on the blukii Info Manager by an Info Manger user. This is an requierement for all BKClient delegates!
  • BKResolveData will be requested during the discovery (see BKClient.initDiscovery()) for all discovered Elelements if the setting BKResolveSettings.resolveEnabled is set true. If some data is responded it will be returned as part of an BKOutputElement by delegate BKClientDiscoveryDelegate.onDiscoveryResult(discoveryResultList: [BKOutputElement]) The result state of resolving can additionally be read by calling BKOuputElement.resolveState:
    • UNRESOLVED: Resolve is off (BKResolveSettings.resolveEnabled is false) or blukii Info Manager is not connectable
    • RESOLVED: blukii Info Manager has responded data for the OutputElement ID
    • NODATA: blukii Info Manager is connectable but has responded no data for the OutputElement ID
    • CACHED: ResolveData contains cached data that has been responded earlier (see cache settings on BKResolveSettings)
  • BKResolveData will be requested for a single Element by calling (see BKClient.resolveInputElement(BKInputElement)). If some data is responded it will be returned as part of an BKOutputElement by delegate BKClientResolveDelegate.onResolveInputElementResult(outputElement: BKOutputElement). The result state of resolving can additionally be read by calling BKOutputElement.resolveState. For single element requests there is no cache available.
    • RESOLVED: blukii Info Manager has responded data for the OutputElement ID
    • NODATA: blukii Info Manager has not responded data for the OutputElement ID
  • The value of the language specific blukii number field Title

    The language is defined by property language.

    Note: If the language specific field Title is not set title contains the value of field Name (as fallback)

    Value of blukii number field Title

    Declaration

    Swift

    internal(set) open var title: String?
  • url

    The Value of the language specific blukii number field URL

    The language is defined by property language

    Note: In most cases getUrl returns an url to a OutputType specific file. Exceptions are:

    Declaration

    Swift

    internal(set) open var url: String?
  • The value of the blukii number selection Option Info

    Declaration

    Swift

    internal(set) open var outputType: BKOutputType? // war ContentType
  • The output language of the BKResolveData set.

    It shows the language specific selection of the blukii number fields url and title, for BKOutputType.PDF also of urlExtra and plainTextExtra

    The output language is chosen by the resolver process. If only one language specific blukii number URL and title is defined it will be returned. Otherwise the language is chosen according the language priority setting (see BKResolveSettings.getLanguagePriority())

    The value can be one of the following languages codes: en-gb, fr-fr or de-de

    Declaration

    Swift

    internal(set) open var language: String?         // war languageCode
  • Gets the value of the language specific blukii number field Audio File URL.

    The language is defined by property language.

    Note: This field is optional and only valid for OutputType PDF (see outputType). It contains a url of an audio file.

    Declaration

    Swift

    internal(set) open var urlExtra: String?  //War FileExtra
  • The value of the language specific blukii number field Text to speech.

    The language is defined by property language.

    Note: This field is optional and only valid for OutputType PDF (see outputType). It contains a text.

    Declaration

    Swift

    internal(set) open var plainTextExtra: String?
  • Gets the value of the blukii number field ‘visibility range’.

    This value contains a Bluetooth module defined value for the rssi range in addition to the global rssi setting. (see DiscoverySetting.getRssiThreshold())

    It does not affect the BLE scan itself but is designed for a better output handling.

    Declaration

    Swift

    internal(set) open var rssi: Int?
  • The value of the date where the blukii Number was resolved

    Declaration

    Swift

    internal(set) open var resolveDate = Date()

    Return Value

    NSDate object