Geführte Touren – Client

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 5 Minuten Lesedauer

    • Die Geführte Touren Die API stellt Methoden zum Starten und Stoppen von geführten Touren bereit.

    Diese API enthält Methoden, die in verwendet werden Designer Für Geführte Tour .

    Geführte Touren – applyListFilter(function Filter_func)

    Legt eine Funktion fest, um gefilterte Tourergebnisse abzurufen, wenn GetAllTours() Methode wird aufgerufen.

    Vollständige Signatureinbindungen Top.NOW.Guided_Tours.api Vor dem Methodennamen.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Filter_Func Funktion Filterfunktion, die eine einzelne verwendet Tour Objekt aus dem Touren[] Array zurückgegeben von GetAllTours() Methode.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt die grundlegende API-Nutzung.

    //create a filter function
var filtFunction = function(tour) {
   //only return those tours whose name starts with 'my'
   return tour.name.indexOf('my') === 0);
}

//apply the filter 
top.NOW.guided_tours.api.applyListFilter (filtFunction);

//call the getAllTours method to observe the filtered tours
top.NOW.guided_tours.api.getAllTours (function(er, tours) {
  if(!er) {
    console.log('The filtered tours are: ');
    console.log(tours);
  }
});

    Das folgende Beispiel zeigt die Verwendung von Optionen Feld im Tourobjekt zum Hinzufügen von JSON mit anwenderdefinierten Tourbezeichnern zum Lesen und Filtern von Touren innerhalb von Filter_func() Funktion.

    top.NOW.guided_tours.api.applyListFilter(function(tour) {
       var options = (tour.options)? JSON.parse(tour.options): null;
       return (options && options.my_param) ? (options.my_param == my_value) : false;
});

    Geführte Touren – endTour()

    Stoppt eine derzeit wiedergegebene Tour. Diese Methode wird automatisch beendet, wenn keine Touren wiedergegeben werden.

    Vollständige Signatureinbindungen Top.NOW.Guided_Tours.api Vor dem Methodennamen.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Null 
    //create a callback function to end the tour if it starts correctly
var cbFunction = function(err) {
	if (err) {
   console.log('Error Occurred');
}
	else {
	   // tour has started so we can call endTour
	   top.NOW.guided_tours.api.endTour();
}
}

//calling the startTour method so that we can end the tour as soon as it starts
top.NOW.guided_tours.api.startTour('a297e04b732313007077edcc5ef6a780', 2, cbFunction);

    Guided Tours – Events.off(Zeichenfolge event_Name, Funktion listener_function)

    Entfernt einen vorhandenen Ereignis-Listener.

    Vollständige Signatureinbindungen Top.NOW.Guided_Tours.api Vor dem Methodennamen.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Ereignisname Zeichenfolge Ereignisname, der aus dem Listener entfernt werden soll.
    Gültige Ereignisnamen:
    • tourStarted
    • tourEnded
    • TourCompleted
    • TourFehlgeschlagen
    • TourAbandoned
    • TourVerworfen
    • Schritt gestartet
    Listener_function Funktion Optional. Falls angegeben, wird die angegebene Listener-Funktion aus den verbleibenden Ereignis-Listenern entfernt, die an dieses Ereignis angehängt sind. Wenn nicht angegeben, werden alle an dieses Ereignis angehängten Listener-Funktionen entfernt.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Keine 
    //create a callback function to handle the result of the api call
var eventListenerTourStarted = function() {
   console.log('The tour has started'); 
}
var eventListenerTourEnded = function() {
   console.log('The tour has ended'); 
}

//attaching event listeners for tourStarted and tourEnded Events
top.NOW.guided_tours.events.on('tourStarted',eventListenerTourStarted);
top.NOW.guided_tours.events.on('tourEnded', eventListenerTourEnded);

…
//start a tour
top.NOW.guided_tours.api.startTour ('a297e04b732313007077edcc5ef6a780', 2, cbFunction);
//As soon as the tour starts the eventListenerTourStarted gets fired
…
top.NOW.guided_tours.api.endTour();
// eventListenerTourEnded gets fired

….

//removing the event listeners top.NOW.guided_tours.events.off('tourStarted',eventListenerTourStarted);
top.NOW.guided_tours.events.off('tourEnded', eventListenerTourEnded);

    Guided Tours – Events.on(Zeichenfolge event_Name, Funktion listener_function)

    Hängt einen Ereignis-Listener an ein Ereignis der geführten Tour an.

    Vollständige Signatureinbindungen Top.NOW.Guided_Tours.api Vor dem Methodennamen.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Ereignisname Zeichenfolge Ereignisname, der an den Listener angehängt werden soll.
    Gültige Ereignisnamen:
    • Schritt gestartet
    • tourStarted
    • tourEnded
    • TourCompleted
    • TourFehlgeschlagen
    • TourAbandoned
    • TourVerworfen
    Listener_function Funktion Listener, der hinzugefügt werden soll.
    Hinweis:
    Löschen Sie jeden Ereignislistener, nachdem er seinen Zweck gelöst hat.
    listener_function.obj Objekt Übergeben an Listener_function() Nach jedem Ereignis im folgenden Format:
    • Für stepStarted-Ereignisse: 
      {tour: '<tour_sys_id>', step: step_num}
    • Für alle anderen Ereignisse:
      {tour: '<tour_sys_id>'}
    JSON-Parameter:
    • Tour_sys_ID: Zeichenfolge. ID der geführten Tour aus der Tabelle „geführte Touren“ [sys_Embedded_Tour_Guide]
    • STEP_num: Nummer. Wert zwischen 0 (erster Schritt) und n (Letzter Schritt)

    Das folgende Beispiel zeigt die grundlegende API-Nutzung.

    //create a callback function to handle the result of the api call
var eventListenerTourStarted = function() {
   console.log('The tour has started'); 
}
var eventListenerTourEnded = function() {
   console.log('The tour has ended'); 
}

//attaching event listeners for tourStarted and tourEnded Events
top.NOW.guided_tours.events.on('tourStarted',eventListenerTourStarted);
top.NOW.guided_tours.events.on('tourEnded', eventListenerTourEnded);

…
//start a tour
top.NOW.guided_tours.api.startTour ('a297e04b732313007077edcc5ef6a780', 2, cbFunction);
//As soon as the tour starts the eventListenerTourStarted gets fired
…
top.NOW.guided_tours.api.endTour();
// eventListenerTourEnded gets fired

….

//removing the event listeners top.NOW.guided_tours.events.off('tourStarted',eventListenerTourStarted);
top.NOW.guided_tours.events.off('tourEnded', eventListenerTourEnded);

    Das folgende Beispiel zeigt die Verwendung von Listener_function Parameter mit Objekt Als Argument.

    top.NOW.guided_tours.events.on("tourStarted", function (obj){console.log(obj);});

    Geführte Touren – getAllTours(function cb_function)

    Ruft eine Liste der Touren auf der aktuellen Seite ab, von der aus diese Methode aufgerufen wird. Da diese Methode asynchron ist, muss eine Rückruffunktion übergeben werden, um den Vorgangserfolg zu bestimmen und eine Liste von Touren abzurufen.

    Vollständige Signatureinbindungen Top.NOW.Guided_Tours.api Vor dem Methodennamen.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    cb_function Funktion Rückruffunktion aufgerufen von GetAllTours() Nach dem Versuch, alle Touren für die aktuelle Seite abzurufen, von der aus GetAllTours() Methode wird aufgerufen.
    cb_function.err Objekt Verweist auf das Fehlerobjekt, falls während des Vorgangs ein Fehler aufgetreten ist:

    ERR = { Erfolg: Falsch, Meldung: 'Zeichenfolge mit Fehlerobjekt' }

    Andernfalls Null.
    cb_function.Tours Array Liste der verfügbaren Touren für die Seite.

    Wenn auf der Seite keine Touren vorhanden sind, cb_function.Tours Gibt nicht definiert zurück.

    If(!tours) Console.log('keine Tour vorhanden')
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Keine 
    //create a callback function to handle the result of the API call
var cbFunction = function(err, tours) {
	if (err) {
   console.log('Error Occurred');
}
	else {
	    if(!tours) console.log('No tour present')
   else {
      tours.forEach(function(t) {
               console.log(t);
             });
          }
}
}
//calling the getTours method
top.NOW.guided_tours.api.getAllTours(cbFunction);

    Geführte Touren – loadPlayer()

    Lädt den Player für geführte Touren auf einer Seite, auf der der Player für geführte Touren standardmäßig nicht vorhanden ist.

    Vollständige Signatur: 
    NOW.guided_tours.api.loadPlayer()
    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    Keine

    Geführte Touren – startTour(Zeichenfolge Tour_ID, Nummer STEP_number, Funktion cb_function)

    Startet eine Tour. Da diese Methode asynchron ist, müssen Sie eine Rückruffunktion übergeben, um den Erfolg des Vorgangs zu bestimmen.

    Vollständige Signatureinbindungen Top.NOW.Guided_Tours.api Vor dem Methodennamen.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Tour_ID Zeichenfolge SYS-ID der Tour aus der Tabelle „geführte Touren“ [sys_Embedded_Tour_Guide].
    STEP_number Anzahl Optional. Schritt, mit dem die Tour gestartet werden soll. Wenn nicht angegeben (oder Schrittnummer ist 0), beginnt die Tour von Anfang an.
    cb_function Funktion Optional. Rückruffunktion aufgerufen von StartTour() Methode nach dem Versuch, die Tour zu starten.
    cb_function.err Objekt Verweist auf das Fehlerobjekt, falls während des Vorgangs ein Fehler aufgetreten ist:

    ERR = { Erfolg: Falsch, Meldung: 'Zeichenfolge mit Fehlerobjekt' }

    Andernfalls Null.
    Tabelle : 13. Rückgaben
    Typ Beschreibung
    Keine 
    //create a callback function to handle the result of the API call
var cbFunction = function(err) {
	if (err) {
   console.log('Error Occurred');
}
	else {
   console.log('The tour with tourid=%s was successfully launched', tourId);
}
}

//calling the startTour method
top.NOW.guided_tours.api.startTour('a297e04b732313007077edcc5ef6a780', 2, cbFunction);