Riferimento API di JavaScript ContextHub contexthub-javascript-api-reference

L'API JavaScript ContextHub è disponibile per gli script quando il componente ContextHub è stato aggiunto alla pagina.

Costanti ContextHub contexthub-constants

Valori costanti definiti dall’API JavaScript ContextHub.

Costanti evento event-constants

Nella tabella seguente sono elencati i nomi degli eventi che si verificano per gli store ContextHub. Vedi anche ContextHub.Utils.Eventing.

Costanti evento interfaccia utente ui-event-constants

Nella tabella seguente sono elencati i nomi degli eventi che si verificano per l’interfaccia utente di ContextHub.

Riferimento API di JavaScript ContextHub contexthub-javascript-api-reference-2

L'oggetto ContextHub consente di accedere a tutti gli archivi.

Funzioni (ContextHub) functions-contexthub

getAllStores() getallstores

Restituisce tutti gli archivi ContextHub registrati.

Questa funzione non ha parametri.

Restituisce returns-

Oggetto che contiene tutti gli archivi ContextHub. Ogni archivio è un oggetto che utilizza lo stesso nome dell'archivio.

Esempio example-

L’esempio seguente recupera tutti gli archivi e quindi l’archivio di geolocalizzazione:

var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation

getStore(name) getstore-name

Recupera un archivio come oggetto JavaScript.

Parametri parameters-

Restituisce returns-getstore-name

Oggetto che rappresenta l’archivio.

Esempio example-getstore-name

L’esempio seguente recupera l’archivio di geolocalizzazione:

var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

Rappresenta un segmento ContextHub. Utilizza ContextHub.SegmentEngine.SegmentManager per ottenere i segmenti.

Funzioni (ContextHub.ContextEngine.Segment) functions-contexthub-contextengine-segment

getName() getname

Restituisce il nome del segmento come valore String.

getPath() getpath

Restituisce il percorso dell’archivio della definizione del segmento come valore String.

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Fornisce accesso ai segmenti ContextHub.

Funzioni (ContextHub.SegmentEngine.SegmentManager) functions-contexthub-segmentengine-segmentmanager

getResolvedSegments() getresolvedsegments

Restituisce i segmenti risolti nel contesto corrente. Questa funzione non ha parametri.

Restituisce returns-getresolvedsegments

Matrice di ContextHub.SegmentEngine.Segment oggetti.

ContextHub.Store.Core contexthub-store-core

La classe base per gli archivi ContextHub.

Proprietà (ContextHub.Store.Core) properties-contexthub-store-core

evento eventing

Un oggetto ContextHub.Utils.Eventing. Utilizzare questo oggetto per le funzioni di associazione per memorizzare gli eventi. Per informazioni sul valore predefinito e sull'inizializzazione, vedere init(name,config).

nome name

Nome dell’archivio.

persistenza persistence

Un oggetto ContextHub.Utils.Persistence. Per informazioni sul valore predefinito e sull'inizializzazione, vedere init(name,config).

Funzioni (ContextHub.Store.Core) functions-contexthub-store-core

addAllItems(tree, options) addallitems-tree-options

Unisce un oggetto dati o un array con i dati dell’archivio. Ogni coppia chiave/valore nell'oggetto o nell'array viene aggiunta all'archivio tramite la funzione setItem:

I valori possono essere oggetti.

Parametri parameters-addallitems

Restituisce returns-addallitems

Un valore boolean:

addReference(key, otherKey) addreference-key-anotherkey

Crea un riferimento da una chiave a un'altra chiave. Una chiave non può fare riferimento a se stessa.

Parametri parameters-addreference

Restituisce returns-addreference

Un valore boolean:

announcementReadiness() announcereadiness

Attiva l'evento ready per questo archivio. Questa funzione non ha parametri e non restituisce alcun valore.

clean() clean

Rimuove tutti i dati dall'archivio. La funzione non ha parametri e nessun valore restituito.

getItem(key) getitem-key

Restituisce il valore associato a una chiave.

Parametri parameters-getitem

Restituisce returns-getitem

Oggetto che rappresenta il valore della chiave.

getKeys(includeInternals) getkeys-includeinternals

Recupera le chiavi dall’archivio. Facoltativamente, puoi recuperare le chiavi utilizzate internamente dal framework ContextHub.

Parametri parameters-getkeys

Restituisce returns-getkeys

Matrice di nomi chiave ( string valori).

getReferences() getreferences

Recupera i riferimenti dall’archivio.

Restituisce returns-getreferences

Matrice che utilizza le chiavi di riferimento come indici per le chiavi di riferimento:

getTree(includeInternals) gettree-includeinternals

Recupera la struttura dati dall'archivio. Facoltativamente, puoi includere le coppie chiave/valore utilizzate internamente dal framework ContextHub.

Parametri parameters-gettree

Restituisce returns-gettree

Oggetto che rappresenta la struttura dati. Le chiavi sono i nomi delle proprietà dell'oggetto.

init(name, config) init-name-config

Inizializza l’archivio.

Parametri parameters-init

isEventingPaused() iseventingpaused

Determina se l'evento viene sospeso per questo archivio.

Restituisce returns-iseventingpaused

Un valore booleano:

pauseEventing() pauseeventing

Sospende l'evento per l'archivio in modo che non venga attivato alcun evento. Questa funzione non richiede parametri e non restituisce alcun valore.

removeItem(key, options) removeitem-key-options

Rimuove una coppia chiave/valore dall'archivio.

Quando viene rimossa una chiave, la funzione attiva l'evento data. I dati dell’evento includono il nome dell’archivio, il nome della chiave rimossa, il valore rimosso, il nuovo valore per la chiave (null) e il tipo di azione "remove".

Facoltativamente, è possibile impedire l'attivazione dell'evento data.

Parametri parameters-removeitem

Restituisce returns-removeitem

Un valore boolean:

removeReference(key) removereference-key

Rimuove un riferimento dall'archivio.

Parametri parameters-removereference

Restituisce returns-removereference

Un valore boolean:

reset(keepRemainingData) reset-keepremainingdata

Reimposta i valori iniziali dei dati persistenti dell'archivio. Facoltativamente, puoi rimuovere tutti gli altri dati dall’archivio. L'evento viene messo in pausa per questo archivio durante la reimpostazione dello stesso. Questa funzione non restituisce alcun valore.

I valori iniziali vengono forniti nella proprietà initialValues dell'oggetto config utilizzato per creare un'istanza dell'oggetto store.

Parametri parameters-reset

resolveReference(key, retry) resolvereference-key-retry

Recupera una chiave di riferimento. Facoltativamente, puoi specificare il numero di iterazioni da utilizzare per risolvere la corrispondenza migliore.

Parametri parameters-resolvereference

Restituisce returns-resolvereference

Valore string che rappresenta la chiave di riferimento. Se non viene risolto alcun riferimento, viene restituito il valore del parametro key.

resumeEventing() resumeeventing

Riprende gli eventi per questo archivio in modo che vengano attivati gli eventi. Questa funzione non definisce alcun parametro e non restituisce alcun valore.

setItem(key, value, options) setitem-key-value-options

Aggiunge una coppia chiave/valore all'archivio.

Attiva l'evento data solo se il valore per la chiave è diverso dal valore attualmente memorizzato per la chiave. È possibile impedire l'attivazione dell'evento data.

I dati evento includono il nome dell'archivio, la chiave, il valore precedente, il nuovo valore e il tipo di azione set.

Parametri parameters-setitem

Restituisce returns-setitem

Un valore boolean:

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

Archivio che contiene dati JSON. I dati vengono recuperati da un servizio JSONP esterno o, facoltativamente, da un servizio che restituisce dati JSON. Specificare i dettagli del servizio utilizzando la funzione init quando si crea un'istanza di questa classe.

L’archivio utilizza la persistenza in memoria (variabile JavaScript). I dati del Negozio sono disponibili solo per la durata della pagina.

ContextHub.Store.JSONPStore estende ContextHub.Store.Core ed eredita le funzioni di tale classe.

Funzioni (ContextHub.Store.JSONPStore) functions-contexthub-store-jsonpstore

configureService(serviceConfig, override) configureservice-serviceconfig-override

Configura i dettagli per la connessione al servizio JSONP utilizzato da questo oggetto. Puoi aggiornare o sostituire la configurazione esistente. La funzione non restituisce alcun valore.

Parametri parameters-configureservice

getRawResponse() getrawresponse

Restituisce la risposta non elaborata memorizzata nella cache dall'ultima chiamata al servizio JSONP. La funzione non richiede parametri.

Restituisce returns-getrawresponse

Oggetto che rappresenta la risposta raw.

getServiceDetails() getservicedetails

Recupera l'oggetto servizio per l'oggetto ContextHub.Store.JSONPStore. L'oggetto servizio contiene le informazioni necessarie per creare l'URL del servizio.

Restituisce returns-getservicedetails

Oggetto con le seguenti proprietà:

getServiceURL(resolve) getserviceurl-resolve

Recupera l’URL del servizio JSONP.

Parametri parameters-getserviceurl

Restituisce returns-getserviceurl

Valore string che rappresenta l'URL del servizio.

init(name, config) init-name-config-1

inizializza l'oggetto ContextHub.Store.JSONPStore.

Parametri parameters-init-1

queryService(reload) queryservice-reload

Interroga il servizio JSONP remoto e memorizza nella cache la risposta. Se il tempo trascorso dalla precedente chiamata a questa funzione è inferiore al valore di config.service.ttl, il servizio non viene chiamato e la risposta memorizzata nella cache non viene modificata. Facoltativamente, puoi forzare la chiamata del servizio. La proprietà config.service.ttlè impostata quando si chiama la funzione init per inizializzare l'archivio.

Attiva l'evento ready al termine della query. Se l'URL del servizio JSONP non è impostato, la funzione non esegue alcuna operazione.

Parametri parameters-queryservice

ripristina reset

Reimposta i valori iniziali dei dati persistenti dell'archivio, quindi chiama il servizio JSONP. Facoltativamente, puoi rimuovere tutti gli altri dati dall’archivio. L'evento viene messo in pausa per questo archivio mentre i valori iniziali vengono reimpostati. Questa funzione non restituisce alcun valore.

I valori iniziali vengono forniti nella proprietà initialValues dell'oggetto config utilizzato per creare un'istanza dell'oggetto store.

Parametri parameters-reset-1

resolveParameter(f) resolveparameter-f

Risolve il parametro specificato.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore estende ContextHub.Store.JSONPStore in modo da ereditare tutte le funzioni di tale classe. Tuttavia, i dati recuperati dal servizio JSONP vengono mantenuti in base alla configurazione della persistenza di ContextHub. (Vedere Modalità di persistenza:)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore estende ContextHub.Store.Core in modo da ereditare tutte le funzioni di tale classe. I dati in questo archivio vengono salvati in modo permanente in base alla configurazione della persistenza di ContextHub.

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore estende ContextHub.Store.Core in modo da ereditare tutte le funzioni di tale classe. I dati in questo archivio vengono salvati in modo permanente utilizzando la persistenza in memoria (oggetto JavaScript).

ContextHub.UI contexthub-ui

Gestisce i moduli UI e i renderer dei moduli UI.

Funzioni (ContextHub.UI) functions-contexthub-ui

registerRenderer(moduleType, renderer, dontRender) registerrenderer-moduletype-renderer-dontrender

Registra un modulo di rendering dell’interfaccia utente con ContextHub. Dopo la registrazione, il renderer può essere utilizzato per creare moduli di interfaccia utente. Utilizza questa funzione quando estendi ContextHub.UI.BaseModuleRenderer per creare un modulo di rendering dell'interfaccia utente personalizzato.

Parametri parameters-registerrenderer

Esempio example-registerrenderer

Nell'esempio seguente viene registrato un renderer come tipo di modulo contexthub.browserinfo.

ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

ContextHub.Utils.Cookie contexthub-utils-cookie

Classe di utilità per l'interazione con i cookie.

Funzioni (ContextHub.Utils.Cookie) functions-contexthub-utils-cookie

exists(key) exists-key

Determina se esiste un cookie.

Parametri parameters-exists

Restituisce returns-exists

Il valore boolean true indica che il cookie esiste.

Esempio example-exists

if (ContextHub.Utils.Cookie.exists("name")) {
   // conditionally-executed code
}

getAllItems(filter) getallitems-filter

Restituisce tutti i cookie con chiavi che corrispondono a un filtro.

Parametri parameters-getallitems

Restituisce returns-getallitems

Oggetto dei cookie. Le proprietà dell’oggetto sono chiavi di cookie e i valori chiave sono valori di cookie.

Esempio example-getallitems

ContextHub.Utils.Cookie.getAllItems([/^cq-authoring/, /^cq-editor/])

getItem(key) getitem-key-1

Restituisce un valore di cookie.

Parametri parameters-getitem-1

Restituisce returns-getitem-1

Il valore del cookie o null se non è stato trovato alcun cookie per la chiave.

Esempio example-getitem-1

ContextHub.Utils.Cookie.getItem("name");

getKeys(filter) getkeys-filter

Restituisce una matrice delle chiavi dei cookie esistenti che corrispondono a un filtro.

Parametri parameters-getkeys-1

Restituisce returns-getkeys-1

Matrice di stringhe in cui ogni stringa è la chiave di un cookie che corrisponde al filtro.

Esempio example-getkeys-1

ContextHub.Utils.Cookie.getKeys([/^cq-authoring/, /^cq-editor/])

removeItem(key, options) removeitem-key-options-1

Rimuovi un cookie. Per rimuovere il cookie, il valore viene impostato su una stringa vuota e la data di scadenza viene impostata sul giorno precedente alla data corrente.

Parametri parameters-removeitem-1

Restituisce returns-removeitem-1

Questa funzione non restituisce un valore.

Esempio example-removeitem-1

ContextHub.Utils.Cookie.vanish([/^cq-authoring/, 'cq-scrollpos']);

setItem(key, value, options) setitem-key-value-options-1

Crea un cookie della chiave e del valore specificati e aggiunge il cookie al documento corrente. Facoltativamente, puoi specificare le opzioni che configurano gli attributi del cookie.

Parametri parameters-setitem-1

Restituisce returns-setitem-1

Cookie con il valore impostato.

Esempio example-setitem-1

ContextHub.Utils.Cookie.setItem("name", "mycookie", {
    expires: 3,
    domain: 'localhost',
    path: '/some/directory',
    secure: true
});

vanish(filtro, opzioni) vanish-filter-options

Rimuove tutti i cookie che corrispondono a un determinato filtro. I cookie vengono associati utilizzando la funzione getKeys e rimossi utilizzando la funzione removeItem.

Parametri parameters-vanish

Restituisce returns-vanish

Questa funzione non restituisce un valore.

ContextHub.Utils.Eventing contexthub-utils-eventing

Consente di associare e annullare l’associazione di funzioni agli eventi store ContextHub. Accedere a ContextHub.Utils.Eventing oggetti per un archivio utilizzando la proprietà eventing dell'archivio.

Funzioni (ContextHub.Utils.Eventing) functions-contexthub-utils-eventing

off(name, selector) off-name-selector

Scollega una funzione da un evento.

Parametri parameters-off

Restituisce returns-off

Questa funzione non restituisce alcun valore.

on(name, handler, selector, triggerForPastEvents) on-name-handler-selector-triggerforpastevents

Associazione una funzione a un evento. La funzione viene chiamata ogni volta che si verifica l’evento. Facoltativamente, la funzione può essere chiamata per eventi che si sono verificati in passato, prima che l’associazione venga stabilita.

Parametri parameters-on

Restituisce returns-on

Quando l'argomento triggerForPastEvents è true, questa funzione restituisce un valore boolean che indica se l'evento si è verificato in passato:

Se triggerForPastEvents è false, questa funzione non restituisce alcun valore.

Esempio example-on

L’esempio seguente associa una funzione all’evento dati dell’archivio di geolocalizzazione. La funzione compila un elemento sulla pagina con il valore per l’elemento di dati di latitudine dall’archivio.

<div class="location">
    <p>latitude: <span id="lat"></span></p>
</div>

<script>
    var geostore = ContextHub.getStore("geolocation");
    geostore.eventing.on(ContextHub.Constants.EVENT_DATA_UPDATE,getlat,"getlat");

    function getlat(){
       latitude = geostore.getItem("latitude");
       $("#lat").html(latitude);
    }
</script>

once(name, handler, selector, triggerForPastEvents) once-name-handler-selector-triggerforpastevents

Associazione una funzione a un evento. La funzione viene chiamata una sola volta, per la prima occorrenza dell’evento. Facoltativamente, la funzione può essere chiamata per l’evento che si è verificato in passato, prima che l’associazione venga stabilita.

Parametri parameters-once

Restituisce returns-once

Quando l'argomento triggerForPastEvents è true, questa funzione restituisce un valore boolean che indica se l'evento si è verificato in passato:

Se triggerForPastEvents è false, questa funzione non restituisce alcun valore.

ContextHub.Utils.inheritance contexthub-utils-inheritance

Classe di utilità che consente a un oggetto di ereditare le proprietà e i metodi di un altro oggetto.

Funzioni (ContextHub.Utils.inheritance) functions-contexthub-utils-inheritance

inherit(child, parent) inherit-child-parent

Fa sì che un oggetto erediti le proprietà e i metodi di un altro oggetto.

Parametri parameters-inherit

ContextHub.Utils.JSON contexthub-utils-json

Fornisce funzioni per serializzare gli oggetti in formato JSON e deserializzare le stringhe JSON negli oggetti.

Funzioni (ContextHub.Utils.JSON) functions-contexthub-utils-json

parse(data) parse-data

Analizza un valore stringa come JSON e lo converte in un oggetto JavaScript.

Parametri parameters-parse

Restituisce returns-parse

Un oggetto JavaScript.

Esempio example-parse

Il codice:

ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}");

Restituisce il seguente oggetto:

Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringivy(data) stringify-data

Serializza i valori e gli oggetti di JavaScript in valori stringa in formato JSON.

Parametri parameters-stringify

Restituisce returns-stringify

Valore stringa serializzato. Quando data è un valore R egExp, questa funzione restituisce un oggetto vuoto. Quando data è una funzione, restituisce undefined.

Esempio example-stringify

Il seguente codice:

ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

Restituisce:

"{'city':'Basel','country':'Switzerland','population':'173330'}":

ContextHub.Utils.JSON.tree contexthub-utils-json-tree

Questa classe facilita la manipolazione degli oggetti dati che devono essere memorizzati o che vengono recuperati dagli archivi ContextHub.

Funzioni (ContextHub.Utils.JSON.tree) functions-contexthub-utils-json-tree

addAllItems() addallitems

Crea una copia di un oggetto dati e vi aggiunge la struttura dati da un secondo oggetto. La funzione restituisce la copia e non modifica nessuno degli oggetti originali. Quando gli alberi dati dei due oggetti contengono chiavi identiche, il valore del secondo oggetto sovrascrive il valore del primo oggetto.

Parametri parameters-addallitems-1

Restituisce returns-addallitems-1

Oggetto contenente i dati uniti.

cleanup() cleanup

Crea una copia di un oggetto, trova e rimuove elementi nella struttura dati che non contengono valori, valori Null o valori non definiti e restituisce la copia.

Parametri parameters-cleanup

Restituisce returns-cleanup

Copia dell'albero pulita.

getItem() getitem

Recupera il valore da un oggetto per la chiave.

Parametri parameters-getitem-2

Restituisce returns-getitem-2

Valore corrispondente alla chiave. Quando la chiave ha chiavi secondarie, questa funzione restituisce un oggetto complesso. Quando il tipo del valore per la chiave è undefined, viene restituito null.

Esempio example-getitem-2

Considera il seguente oggetto JavaScript:

myObject {
  user: {
    location: {
      city: "Basel",
        details: {
          population: 173330,
          elevation: 260
        }
      }
    }
  }

Il codice di esempio seguente restituisce il valore 260:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");

Il codice di esempio seguente recupera il valore di una chiave con chiavi secondarie:

ContextHub.Utils.JSON.tree.getItem(myObject, "/user");

La funzione restituisce il seguente oggetto:

Object {
  location: {
    city: "Basel",
    details: {
      population: 173330,
      elevation: 260
    }
  }
}

getKeys() getkeys

Recupera tutte le chiavi dalla struttura dati di un oggetto. Facoltativamente, puoi recuperare solo le chiavi degli elementi secondari di una chiave specifica. Facoltativamente, puoi anche specificare l’ordinamento delle chiavi recuperate.

Parametri parameters-getkeys-2

Restituisce returns-getkeys-2

Matrice di chiavi.

Esempio example-getkeys-2

Considera il seguente oggetto:

myObject {
  location: {
    weather: {
      temperature: "28C",
      humidity: "77%",
      precipitation: "10%",
      wind: "8km/h"
    },
    city: "Basel",
    country: "Switzerland",
    longitude: 7.5925727,
    latitude: 47.557421
  }
}

Lo script ContextHub.Utils.JSON.tree.getKeys(myObject); restituisce il seguente array:

["/location", "/location/city", "/location/country", "/location/latitude", "/location/longitude", "/location/weather", "/location/weather/humidity", "/location/weather/precipitation", "/location/weather/temperature", "/location/weather/wind"]

removeItem() removeitem

Crea una copia di un determinato oggetto, rimuove il ramo specificato dalla struttura dati e restituisce la copia modificata.

Parametri parameters-removeitem-2

Restituisce returns-removeitem-2

Copia dell'oggetto dati originale con la chiave rimossa.

Esempio example-removeitem-2

Considera il seguente oggetto:

myObject {
  one: {
    foo: "bar",
    two: {
      three: {
        four: {
          five: 5,
          six: 6
        }
      }
    }
  }
}

Lo script di esempio seguente rimuove il ramo /one/two/three/four dalla struttura dati:

myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");

La funzione restituisce il seguente oggetto:

myObject {
  one: {
    foo: "bar"
  }
}

sanitizeKey(key) sanitizekey-key

Sanitizza i valori stringa per renderli utilizzabili come chiavi. Per bonificare una stringa, questa funzione esegue le azioni seguenti:

Utilizza l’array risultante per creare una chiave utilizzabile.

Parametri parameters-sanitizekey

Restituisce returns-sanitizekey

Matrice di string valori in cui ogni stringa è la porzione di key delimitata da barre. rappresenta la chiave bonificata. Se la lunghezza dell'array bonificato è zero, questa funzione restituisce null.

Esempio example-sanitizekey

Il codice seguente bonifica una stringa per produrre l'array ["this", "is", "a", "path"], quindi genera la chiave "/this/is/a/path" dall'array:

var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(tree, key, value) setitem-tree-key-value

Aggiunge una coppia chiave/valore alla struttura dati di una copia di un oggetto. Per informazioni sulle strutture dati, vedere Persistenza.

Parametri parameters-setitem-2

Restituisce returns-setitem-2

Copia dell'oggetto tree che include la coppia key/ value.

Esempio example-setitem-2

Considera il seguente codice JavaScript:

var myObject = {
     user: {
        location: {
           city: "Basel"
           }
        }
     };

var myKey = "/user/location/details";

var myValue = {
      population: 173330,
      elevation: 260
     };

myObject = ContextHub.Utils.JSON.tree.setItem(myObject, myKey, myValue);

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

Consente di registrare i candidati per lo store e di ottenere i candidati per lo store registrati.

Funzioni (ContextHub.Utils.storeCandidates) functions-contexthub-utils-storecandidates

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

Restituisce i tipi di punto vendita registrati come candidati. Recupera i candidati registrati di un tipo di archivio specifico o di tutti i tipi di archivio.

Parametri parameters-getregisteredcandidates

Restituisce returns-getregisteredcandidates

Oggetto di tipo store. Le proprietà dell'oggetto sono i nomi dei tipi di archivio e i valori delle proprietà sono una matrice dei candidati di archivio registrati.

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

Restituisce un tipo di archivio dai candidati registrati. Se sono registrati più tipi di archivio con lo stesso nome, la funzione restituisce il tipo di archivio con la priorità più elevata.

Parametri parameters-getstorefromcandidates

Restituisce returns-getstorefromcandidates

Oggetto che rappresenta il candidato dell'archivio registrato. Se il tipo di archivio richiesto non è registrato, viene generato un errore.

getSupportedStoreTypes() getsupportedstoretypes

Restituisce i nomi dei tipi di punto vendita registrati come candidati. Questa funzione non richiede parametri.

Restituisce returns-getsupportedstoretypes

Matrice di valori stringa, in cui ogni stringa è lo storetype con cui è stato registrato il candidato dell'archivio. Vedere il parametro storeType della funzione ContextHub.Utils.storeCandidates.registerStoreCandidate.

registerStoreCandidate(store, storeType, priority, apply) registerstorecandidate-store-storetype-priority-applies

Registra un oggetto store come candidato all'archivio utilizzando un nome e una priorità.

La priorità è un numero che indica l'importanza degli archivi con lo stesso nome. Quando un candidato per lo store viene registrato con lo stesso nome di un candidato per lo store già registrato, viene utilizzato il candidato con la priorità più elevata. Quando si registra un candidato per un punto vendita, l'archivio viene registrato solo se la priorità è superiore a quella dei candidati per lo stesso punto vendita registrati con lo stesso nome.

Parametri parameters-registerstorecandidate

Esempio example-registerstorecandidate

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);