---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Geführte Touren -- Client

# Geführte Touren -- Client {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer

Die Geführte Touren Die API bietet Methoden zum Starten und Stoppen von geführten Touren.

Diese API enthält Methoden, die in verwendet werden [Designer Für Geführte Tour](https://servicenow-prod.fluidtopics.net/9Xv9oa1y5A3vVbAgAaBorg "REST-Nachrichten, die an eine Instanz gesendet werden, geben einen bestimmten HTTP-Antwortcode zurück.").

## Geführte Touren -- applyListFilter(function Filter_func) {#ariaid-title2}

Legt eine Funktion zum Abrufen gefilterter Tourergebnisse fest, wenn `GetAllTours() `Methode wird aufgerufen.
Vollständige Signatureinbindungen `Top.NOW.Guided_Tours.api `Vor dem Methodennamen.
{#GT-applyListFilter_F__table_pqn_dbs_xhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Filter_Func | Funktion | Filterfunktion, die eine einzelne benötigt `Tour `Objekt aus `Touren[] `Array zurückgegeben von `GetAllTours() `Methode. |
[Tabelle : 1. Parameter]

{#GT-applyListFilter_F__table_pqn_dbs_xhb} {#GT-applyListFilter_F__table_qqn_dbs_xhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Rückgaben]

{#GT-applyListFilter_F__table_qqn_dbs_xhb}  
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, wie verwendet wird `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() {#ariaid-title3}

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.
{#GT-endTour__table_g5n_3cs_xhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 3. Parameter]

{#GT-endTour__table_g5n_3cs_xhb} {#GT-endTour__table_h5n_3cs_xhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Null |   |
[Tabelle : 4. Rückgaben]

{#GT-endTour__table_h5n_3cs_xhb}  

    //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);

## Geführte Touren -- Events.off(Zeichenfolge event_Name, Funktion listener_function) {#ariaid-title4}

Entfernt einen vorhandenen Ereignis-Listener.
Vollständige Signatureinbindungen `Top.NOW.Guided_Tours.api `Vor dem Methodennamen.
{#GT-events.off_S_F__table_iwb_kbs_xhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Ereignisname | Zeichenfolge | Ereignisname, der aus dem Listener entfernt werden soll. Gültige Ereignisnamen: * tourStarted * tourEnded * TourCompleted * TourFehlgeschlagen * Tourabandoned * TourVerworfen * Schritt gestartet {#GT-events.off_S_F__ul_tn1_x4t_yhb} |
| Listener_function | Funktion | Optional. Wenn 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 : 5. Parameter]

{#GT-events.off_S_F__table_iwb_kbs_xhb} {#GT-events.off_S_F__table_jwb_kbs_xhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 6. Rückgaben]

{#GT-events.off_S_F__table_jwb_kbs_xhb}  

    //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);

## Geführte Touren -- Events.on(Zeichenfolge event_Name, Funktion listener_function) {#ariaid-title5}

Hängt einen Ereignis-Listener an ein Ereignis der geführten Tour an.
Vollständige Signatureinbindungen `Top.NOW.Guided_Tours.api `Vor dem Methodennamen.
{#GT-events.on_S_F__table_iwb_kbs_xhb__entry__3}

| 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 {#GT-events.on_S_F__ul_tn1_x4t_yhb} |
| 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>'} {#GT-events.on_S_F__ul_wsr_khs_g3b} 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) {#GT-events.on_S_F__ul_qfx_nhs_g3b} |
[Tabelle : 7. Parameter]

{#GT-events.on_S_F__table_iwb_kbs_xhb}  
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, wie verwendet wird `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) {#ariaid-title6}

Ruft eine Liste von Touren auf der aktuellen Seite ab, von der 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.
{#GT-getAllTours_F__table_nrj_bbs_xhb__entry__3}

| 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: `Fehler = { 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 : 8. Parameter]

{#GT-getAllTours_F__table_nrj_bbs_xhb} {#GT-getAllTours_F__table_orj_bbs_xhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Rückgaben]

{#GT-getAllTours_F__table_orj_bbs_xhb}  

    //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() {#ariaid-title7}

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()

{#GT-loadPlayer__table_g5n_3cs_xhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 10. Parameter]

{#GT-loadPlayer__table_g5n_3cs_xhb} {#GT-loadPlayer__table_h5n_3cs_xhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Rückgaben]

{#GT-loadPlayer__table_h5n_3cs_xhb}

## Geführte Touren -- startTour (Zeichenfolge Tour_ID, Nummer STEP_number, Funktion cb_function) {#ariaid-title8}

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.
{#GT-startTour_S_N_F__table_wh5_w1s_xhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Tour_ID | Zeichenfolge | SYS-ID der Tour aus der Tabelle „geführte Touren" \[sys_embedded_tour_guide\]. |
| STEP_number | Nummer | 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: `Fehler = { Erfolg: Falsch, Meldung: 'Zeichenfolge mit Fehlerobjekt' }` Andernfalls Null. |
[Tabelle : 12. Parameter]

{#GT-startTour_S_N_F__table_wh5_w1s_xhb} {#GT-startTour_S_N_F__table_xh5_w1s_xhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 13. Rückgaben]

{#GT-startTour_S_N_F__table_xh5_w1s_xhb}  

    //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);


