VenueService

public class VenueService
extension VenueService: NativeBase
extension VenueService: Hashable

Offers methods to download venues. Use of this object does not necessitate Map involvement.

Before loading the venues, initialize the venue service with one of the start methods.

The venue service is online only. Even if there is a cached venue on the device, the venue service requires an online connection to check if the venue is available for the user.

  • Undocumented

    Declaration

    Swift

    public typealias Int32Array = [Int32]

  • Undocumented

    Declaration

    Swift

    public typealias StringArray = [String]

  • Undocumented

    Declaration

    Swift

    public typealias VenueInfoList = [VenueInfo]

  • Undocumented

    Declaration

    Swift

    public typealias VenueOptionalFeatureList = [VenueService.VenueOptionalFeature]

  • The languages available in the venue service.

    Declaration

    Swift

    public var languages: VenueService.StringArray { get }

  • The active language. The venue service will try to load a venue with a translation in the active language. If such translation doesn’t exist, a venue will be loaded in its default language.

    Declaration

    Swift

    public var language: String { get set }

  • Optional features enum

    See more

    Declaration

    Swift

    public enum VenueOptionalFeature : UInt32, CaseIterable, Codable

  • Stops the venue service.

    Declaration

    Swift

    public func stop()

  • Adds a service delegate. The delegate is not added if it is nil or is already present in the list of delegates.

    Declaration

    Swift

    public func addServiceDelegate(_ delegate: VenueServiceDelegate)

    Parameters

    delegate

    The service delegate to add.

  • Removes a service delegate. The delegate is not removed if it is not present in the list of delegates.

    Declaration

    Swift

    public func removeServiceDelegate(_ delegate: VenueServiceDelegate)

    Parameters

    delegate

    The service delegate to remove.

  • Adds a venue delegate. The delegate is not added if it is nil or is already present in the list of delegates.

    Declaration

    Swift

    public func addVenueDelegate(_ delegate: VenueDelegate)

    Parameters

    delegate

    The venue delegate to add.

  • Removes a venue delegate. The delegate is not removed if it is not present in the list of delegates.

    Declaration

    Swift

    public func removeVenueDelegate(_ delegate: VenueDelegate)

    Parameters

    delegate

    The venue delegate to remove.

  • Adds a venue map delegate. The delegate is not added if it is nil or is already present in the list of delegates.

    Declaration

    Swift

    public func addVenueMapDelegate(_ delegate: VenueMapDelegate)

    Parameters

    delegate

    The venue map delegate to add.

  • Removes a venue map delegate. The delegate is not removed if it is not present in the list of delegates.

    Declaration

    Swift

    public func removeVenueMapDelegate(_ delegate: VenueMapDelegate)

    Parameters

    delegate

    The venue map delegate to remove.

  • Gets an initialization status.

    Declaration

    Swift

    public func getInitStatus() -> VenueServiceInitStatus

    Return Value

    The initialization status.

  • Checks if the venue service is initialized.

    Declaration

    Swift

    public func isInitialized() -> Bool

    Return Value

    True if the venue service is initialized and false otherwise.

  • Adds a venue to the loading queue.

    Declaration

    Swift

    public func addVenueToLoad(venueId: Int32)

    Parameters

    venueId

    The id of the venue to load.

  • Adds a venue to the loading queue.

    Declaration

    Swift

    public func addVenueToLoad(venueIdentifier: String)

    Parameters

    venueIdentifier

    The id of the venue to load.

  • Sets HRN of platform catalog.

    Declaration

    Swift

    public func setHrn(hrn: String)

    Parameters

    hrn

    The HRN of platform catalog.

  • Sets override labelTextPreference for labels.

    Declaration

    Swift

    public func setLabeltextPreference(labelTextPref: [String])

    Parameters

    labelTextPref

    The list of string override labelTextPreference.

    “OCCUPANT_NAMES” - To display only occupant names on map as a label text. Example: Boutique Du Chocolat for id 7348

    “SPACE_NAME” - To display only space names on map as a label text. Example: Family Services/First Aid for id 7348

    “SPACE_TYPE_NAME” - To display only space types on map as a label text. Example: DEFIBRILLATOR for id 7348

    “SPACE_CATEGORY_NAME” - To display only space categories on map as a label text. Example: SAFETY for id 7348

    “INTERNAL_ADDRESS” - To display only internal addresses on map as a label text. Example: 51/D for id 7348

  • Lets user load topologies for current session

    Declaration

    Swift

    public func loadTopologies()

  • Lets user load optional features for current session.

    Declaration

    Swift

    public func loadOptionalFeatures(optionalFeatureList: VenueService.VenueOptionalFeatureList)

    Parameters

    optionalFeatureList

    The list of optional feature enum VenueOptionalFeature.