Class VenueService

java.lang.Object
com.here.NativeBase
com.here.sdk.venue.service.VenueService

public final class VenueService extends NativeBase

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.

  • Method Details

    • stop

      public void stop()

      Stops the venue service.

    • add

      public void add(@NonNull VenueServiceListener listener)

      Adds a service listener. The listener is not added if it is null or is already present in the list of listeners.

      Parameters:
      listener -

      The service listener to add.

    • remove

      public void remove(@NonNull VenueServiceListener listener)

      Removes a service listener. The listener is not removed if it is not present in the list of listeners.

      Parameters:
      listener -

      The service listener to remove.

    • add

      public void add(@NonNull VenueListener listener)

      Adds a venue listener. The listener is not added if it is null or is already present in the list of listeners.

      Parameters:
      listener -

      The venue listener to add.

    • remove

      public void remove(@NonNull VenueListener listener)

      Removes a venue listener. The listener is not removed if it is not present in the list of listeners.

      Parameters:
      listener -

      The venue listener to remove.

    • add

      public void add(@NonNull VenueMapListener listener)

      Adds a venue map listener. The listener is not added if it is null or is already present in the list of listeners.

      Parameters:
      listener -

      The venue map listener to add.

    • remove

      public void remove(@NonNull VenueMapListener listener)

      Removes a venue map listener. The listener is not removed if it is not present in the list of listeners.

      Parameters:
      listener -

      The venue map listener to remove.

    • getInitStatus

      @NonNull public VenueServiceInitStatus getInitStatus()

      Gets an initialization status.

      Returns:

      The initialization status.

    • isInitialized

      public boolean isInitialized()

      Checks if the venue service is initialized.

      Returns:

      True if the venue service is initialized and false otherwise.

    • addVenueToLoad

      public void addVenueToLoad(int venueId)

      Adds a venue to the loading queue.

      Parameters:
      venueId -

      The id of the venue to load.

    • addVenueToLoad

      public void addVenueToLoad(@NonNull String venueIdentifier)

      Adds a venue to the loading queue.

      Parameters:
      venueIdentifier -

      The id of the venue to load.

    • setHrn

      public void setHrn(@NonNull String hrn)

      Sets HRN of platform catalog.

      Parameters:
      hrn -

      The HRN of platform catalog.

    • setLabeltextPreference

      public void setLabeltextPreference(@NonNull List<String> labelTextPref)

      Sets override labelTextPreference for labels.

      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

    • loadTopologies

      public void loadTopologies()

      Lets user load topologies for current session

    • loadOptionalFeatures

      public void loadOptionalFeatures(@NonNull List<VenueService.VenueOptionalFeature> optionalFeatureList)

      Lets user load optional features for current session.

      Parameters:
      optionalFeatureList -

      The list of optional feature enum VenueOptionalFeature.

    • getLanguages

      @NonNull public List<String> getLanguages()

      Gets the languages available in the venue service.

      Returns:

      The languages available in the venue service.

    • getLanguage

      @NonNull public String getLanguage()

      Gets an active language in the venue service.

      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.

      Returns:

      The active language.

    • setLanguage

      public void setLanguage(@NonNull String value)

      Sets an 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.

      Parameters:
      value -

      The active language.