Show Menu
THEMEN×

Referenz zur ContextHub-JavaScript-API

Die ContextHub-JavaScript-API ist für Ihre Skripte verfügbar, wenn die ContextHub-Komponente zur Seite hinzugefügt wurde .

ContextHub-Konstanten

Konstante Werte, die von der ContextHub-JavaScript-API definiert werden.

Ereigniskonstanten

In der folgenden Tabelle sind die Namen von Ereignissen aufgeführt, die bei ContextHub-Stores auftreten. Siehe auch ContextHub.Utils.Eventing
Konstante
Beschreibung
Wert
ContextHub.Constants.EVENT_NAMESPACE
ContextHub-Ereignis-Namensraum
ch
ContextHub.Constants.EVENT_ALL_STORES_READY
Gibt an, dass alle erforderlichen Stores registriert, initialisiert und einsatzbereit sind
all-stores-ready
ContextHub.Constants.EVENT_STORES_PARTIALLY_READY
Gibt an, dass nicht alle Stores innerhalb eines bestimmten Timeouts initialisiert wurden
stores-partially-ready
ContextHub.Constants.EVENT_STORE_REGISTERED
Wird ausgelöst, wenn ein Store registriert ist
store-registered
ContextHub.Constants.EVENT_STORE_READY
Gibt an, dass die Stores einsatzbereit sind. Wird sofort nach der Registrierung ausgelöst, außer bei JSONP-Stores, wo es ausgelöst wird, wenn Daten abgerufen werden.
store-ready
ContextHub.Constants.EVENT_STORE_UPDATED
Wird ausgelöst, wenn ein Store seine Persistenz aktualisiert
store-updated
ContextHub.Constants.PERSISTENCE_CONTAINER_NAME
Name des Persistent-Containers
ContextHubPersistence
ContextHub.Constants.SERVICE_RAW_RESPONSE_KEY
Speichert den spezifischen Namen des Persistenzschlüssels, in dem das unformatierte JSON-Ergebnis gespeichert wird
/_/raw-response
ContextHub.Constants.SERVICE_RESPONSE_TIME_KEY
Speichert einen bestimmten Zeitstempel, der angibt, wann JSON-Daten abgerufen wurden
/_/response-time
ContextHub.Constants.SERVICE_LAST_URL_KEY
Speichert spezifische URL des JSON-Dienstes, der während des letzten Aufrufs verwendet wird
/_/url
ContextHub.Constants.IS_CONTAINER_EXPANDED
Gibt an, ob die Benutzeroberfläche von ContextHub erweitert wird
/_/container-expanded

Benutzeroberflächen-Ereigniskonstanten

In der folgenden Tabelle sind die Namen der Ereignisse aufgeführt, die für die ContextHub-Benutzeroberfläche auftreten.
Konstante
Beschreibung
Wert
ContextHub.Constants.EVENT_UI_MODE_REGISTERED
Wird ausgelöst, wenn ein Modus registriert ist
ui-mode-registered
ContextHub.Constants.EVENT_UI_MODE_UNREGISTERED
Wird ausgelöst, wenn ein Modus nicht registriert ist
ui-mode-unregistered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_REGISTERED
Wird ausgelöst, wenn ein Modus-Renderer registriert ist
ui-mode-renderer-registered
ContextHub.Constants.EVENT_UI_MODE_RENDERER_UNREGISTERED
Wird ausgelöst, wenn ein Modus-Renderer nicht registriert ist
ui-mode-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODE_ADDED
Wird ausgelöst, wenn ein neuer Modus hinzugefügt wird
ui-mode-added
ContextHub.Constants.EVENT_UI_MODE_REMOVED
Wird ausgelöst, wenn ein Modus entfernt wird
ui-mode-removed
ContextHub.Constants.EVENT_UI_MODE_SELECTED
Wird ausgelöst, wenn der Benutzer einen Modus auswählt
ui-mode-selected
ContextHub.Constants.EVENT_UI_MODULE_REGISTERED
Wird ausgelöst, wenn ein neues Modul registriert wird
ui-module-registered
ContextHub.Constants.EVENT_UI_MODULE_UNREGISTERED
Wird ausgelöst, wenn ein Modul nicht registriert ist
ui-module-unregistered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_REGISTERED
Wird ausgelöst, wenn ein Modul-Renderer registriert ist
ui-module-renderer-registered
ContextHub.Constants.EVENT_UI_MODULE_RENDERER_UNREGISTERED
Wird ausgelöst, wenn ein Modul-Renderer nicht registriert ist
ui-module-renderer-unregistered
ContextHub.Constants.EVENT_UI_MODULE_ADDED
Wird ausgelöst, wenn ein neues Modul hinzugefügt wird
ui-module-added
ContextHub.Constants.EVENT_UI_MODULE_REMOVED
Wird ausgelöst, wenn ein Modul entfernt wird
ui-module-removed
ContextHub.Constants.EVENT_UI_CONTAINER_ADDED
Wird ausgelöst, wenn der UI-Container der Seite hinzugefügt wird
ui-container-added
ContextHub.Constants.EVENT_UI_CONTAINER_OPENED
Wird ausgelöst, wenn die ContextHub-Benutzeroberfläche geöffnet wird
ui-container-opened
ContextHub.Constants.EVENT_UI_CONTAINER_CLOSED
Wird ausgelöst, wenn die ContextHub-Benutzeroberfläche reduziert wird
ui-container-closed
ContextHub.Constants.EVENT_UI_PROPERTY_MODIFIED
Wird ausgelöst, wenn eine Eigenschaft geändert wird
ui-property-modified
ContextHub.Constants.EVENT_UI_RENDERED
Wird jedes Mal ausgelöst, wenn die ContextHub-Benutzeroberfläche wiedergegeben wird (z. B. nach einer Eigenschaftenänderung)
ui-rendered
ContextHub.Constants.EVENT_UI_INITIALIZED
Wird ausgelöst, wenn UI-Container initialisiert wird
ui-initialized
ContextHub.Constants.ACTIVE_UI_MODE
Zeigt den aktiven UI-Modus an
/_/active-ui-mode

Referenz zur ContextHub-JavaScript-API

Das ContextHub-Objekt bietet Zugriff auf alle Stores.

Funktionen (ContextHub)

getAllStores()

Gibt alle registrierten ContextHub-Stores zurück.
Diese Funktion hat keine Parameter.
Rückgabe
Ein Objekt, das alle ContextHub-Stores enthält. Jeder Store ist ein Objekt, das denselben Namen wie der Store verwendet.
Beispiel
Im folgenden Beispiel werden alle Stores und anschließend der Geolocation-Store abgerufen:
var allStores = ContextHub.getAllStores();
var geoloc = allStores.geolocation

getStore(name)

Ruft einen Store als ein JavaScript-Objekt ab.
Parameter
  • name : Der Name, mit dem der Store registriert wurde.
Rückgabe
Ein Objekt, das den Store darstellt.
Beispiel
Im folgenden Beispiel wird der Geolocation-Store abgerufen:
var geoloc = ContextHub.getStore("geolocation");

ContextHub.SegmentEngine.Segment

Stellt ein ContextHub-Segment dar. Use the ContextHub.SegmentEngine.SegmentManager to obtain segments.

Funktionen (ContextHub.ContextEngine.Segment)

getName()

Gibt den Namen des Segments als Stringwert zurück.

getPath()

Gibt den Repository-Pfad der Segmentdefinition als String-Wert zurück.

ContextHub.SegmentEngine.SegmentManager

Bietet Zugriff auf ContextHub-Segmente.

Funktionen (ContextHub.SegmentEngine.SegmentManager)

getResolvedSegments()

Gibt die Segmente zurück, die im aktuellen Kontext aufgelöst werden. Diese Funktion hat keine Parameter.
Rückgabe
An array of ContextHub.SegmentEngine.Segment objects.

ContextHub.Store.Core

Die Basisklasse für ContextHub-Stores.

Eigenschaften (ContextHub.Store.Core)

Vielseitigkeit

Ein ContextHub.Utils.Eventing Objekt. Verwenden Sie dieses Objekt zum Binden von Funktionen zum Speichern von Ereignissen. For information about the default value and initialization, see init(name,config) .

name

Der Name des Stores.

persistence

Ein ContextHub.Utils.Persistence Objekt. For information about the default value and initialization, see init(name,config) .

Funktionen (ContextHub.Store.Core)

addAllItems(tree, options)

Führt ein Datenobjekt oder ein Array mit den Storedaten zusammen. Jedes Schlüssel/Wert-Paar im Objekt oder Array wird dem Store hinzugefügt (über die Funktion setItem ):
  • Objekt: Schlüssel sind die Eigenschaftsnamen.
  • Array: Schlüssel sind die Array-Indizes.
Beachten Sie, dass Werte Objekte sein können.
Parameter
  • tree : (Objekt oder Array) Die Daten, die dem Store hinzugefügt werden sollen.
  • options : (Objekt) Ein optionales Objekt von Optionen, das an die setItem-Funktion übergeben wird. For information, see the options parameter of setItem(key,value,options) .
Rückgabe
Ein boolean Wert:
  • Der Wert true gibt an, dass das Datenobjekt gespeichert wurde.
  • Der Wert false gibt an, dass der Datenstore unverändert ist.

addReference(key, anotherKey)

Erstellt eine Referenz von einem Schlüssel auf einem anderen Schlüssel. Ein Schlüssel kann sich nicht selbst referenzieren.
Parameter
  • key : Der Schlüssel, auf den verwiesen wird anotherKey .
  • anotherkey : Sie Schlüssel, auf den verwiesen wird key .
Rückgabe
Ein boolean Wert:
  • Der Wert true gibt an, dass die Referenz hinzugefügt wurde.
  • Der Wert false gibt an, dass keine Referenz hinzugefügt wurde.

announceReadiness()

Löst das ready -Ereignis für diesen Store aus. Diese Funktion hat keine Parameter und gibt keinen Wert zurück.

clean()

Entfernt alle Daten aus dem Store. Die Funktion hat keine Parameter und keinen Rückgabewert.

getItem(key)

Gibt den Wert zurück, der einem Schlüssel zugeordnet ist.
Parameter
  • key : (String) der Schlüssel, für den der Wert zurückgegeben werden soll.
Rückgabe
Ein Objekt, das den Wert für den Schlüssel darstellt.

getKeys(includeInternals)

Ruft die Schlüssel aus dem Store ab. Optional können Sie die Schlüssel abrufen, die intern vom ContextHub-Framework verwendet werden.
Parameter
  • includeInternals : Der Wert true schließt intern verwendete Schlüssel in die Ergebnisse ein. These keys begin with the underscore ( _ ) character. Der Standardwert ist false .
Rückgabe
Ein Array von Schlüsselnamen ( string -Werte).

getReferences()

Ruft die Referenzen aus dem Store ab.
Rückgabe
Ein Array, das referenzierende Schlüssel als Indizes für die referenzierten Schlüssel verwendet:
  • Referencing keys correspond with the key parameter of the addReference function.
  • Referenced keys correspond with the anotherKey parameter of the addReference function.

getTree(includeInternals)

Ruft den Datenbaum vom Store ab. Optional können Sie die Schlüssel/Wert-Paare einschließen, die intern vom ContextHub-Framework verwendet werden.
Parameter
  • includeInternals: Ein Wert von true enthält intern verwendete Schlüssel/Wert-Paare in den Ergebnissen. The keys of this data begin with the underscore ( _ ) character. Der Standardwert ist false .
Rückgabe
Ein Objekt, das die Datenstruktur darstellt. Die Schlüssel sind die Eigenschaftsnamen des Objekts.

init(name, config)

Initialisiert den Store.
  • Setzt die Storedaten auf ein leeres Objekt.
  • Setzt die Storereferenzen auf ein leeres Objekt.
  • The eventChannel is data:<name> , where <name> is the store name.
  • The storeDataKey is /store/<name> , where <name> is the store name.
Parameter
  • name : Der Name des Stores.
  • config : Ein Objekt, das Konfigurationseigenschaften enthält:
    • eventDeferring : Der Standardwert ist 32.
    • eventing : Das ContextHub.Utils.Eventing -Objekt für diesen Store. The default value is the ContextHub.eventing object uses.
    • persistence : Das ContextHub.Utils.Persistence Objekt für diesen Store. Der Standardwert ist das ContextHub.persistence -Objekt.

isEventingPaused()

Ermittelt, ob das Eventing für diesen Store angehalten wurde.
Rückgabe
Ein boolescher Wert:
  • true : Eventing ist angehalten, sodass keine Ereignisse für diesen Store ausgelöst werden.
  • false : Eventing ist nicht angehalten, sodass Ereignisse für diesen Store ausgelöst werden.

PauseEventing()

Hält Eventing für den Store an, sodass keine Ereignisse ausgelöst werden. Diese Funktion erfordert keine Parameter und gibt keinen Wert zurück.

removeItem(key, options)

Entfernt ein Schlüssel/Wert-Paar aus dem Store.
Wenn ein Schlüssel entfernt wird, löst die Funktion das data -Ereignis aus. Zu den Ereignis-Daten gehören der Name des Speichers, der Name des entfernten Schlüssels, der entfernte Wert, der neue Wert des Schlüssels (null) und der Aktionstyp "remove".
Optional können Sie das Auslösen des Ereignisses data verhindern.
Parameter
  • key : (String) Der Name des zu entfernenden Schlüssels.
  • options : (Objekt) Ein Objekt von Optionen. Die folgenden Objekteigenschaften sind gültig:
    • silent: Ein Wert true verhindert das Auslösen des data -Ereignisses. Der Standardwert ist false .
Rückgabe
Ein boolean Wert:
  • A value of true indicates the key/value pair was removed.
  • A value of false indicates that the data store is unchanged because the key was not found in the store.

removeReference(key)

Entfernt eine Referenz aus dem Store.
Parameter
  • key : Die zu entfernende Schlüsselreferenz. This parameter corresponds with the key parameter of the addReference function.
Rückgabe
Ein boolean Wert:
  • A value of true indicates the reference was removed.
  • A value of false indicates that the key was not valid and the store is unchanged.

reset(keepRemainingData)

Setzt die Anfangswerte der persistenten Daten des Stores zurück. Optional können Sie alle anderen Daten aus dem Store entfernen. Eventing wird für diesen Store angehalten, während der Store zurückgesetzt wird. Diese Funktion gibt keinen Wert zurück.
Initial values are provided in the initialValues property of the config object that is used to instantiate the store object.
Parameter
  • keepRemainingData : (Boolesch) Ein Wert „true“ bewirkt, dass nicht-initial-Daten beibehalten werden. Der Wert „false“ bewirkt, dass alle Daten mit Ausnahme der Anfangswerte entfernt werden.

resolveReference(key, retry)

Ruft einen referenzierten Schlüssel ab. Optional können Sie die Anzahl der Iterationen angeben, die zum Lösen der besten Übereinstimmung verwendet werden sollen.
Parameter
  • key : (String) Der Schlüssel, für den die Referenz aufgelöst werden soll. This key parameter corresponds with the key parameter of the addReference function.
  • retry : (Number) Die Anzahl der zu verwendenden Iterationen.
Rückgabe
Ein string -Wert, der den referenzierten Schlüssel darstellt. Wenn keine Referenz aufgelöst wird, wird der Wert des key -Parameters zurückgegeben.

resumeEventing()

Setzt Eventing für diesen Store fort, sodass Ereignisse ausgelöst werden. Diese Funktion definiert keine Parameter und gibt keinen Wert zurück.

setItem(key, value, options)

Fügt ein Schlüssel/Wert-Paar dem Store hinzu.
Löst das data -Ereignis nur aus, wenn der Wert für den Schlüssel sich von dem Wert unterscheidet, der aktuell für den Schlüssel gespeichert ist. Optional können Sie das Auslösen des data -Ereignisses verhindern.
Die Ereignisdaten umfassen den Storenamen, den Schlüssel, den vorherigen Wert, den neuen Wert und den Aktionstyp von set .
Parameter
  • key : (String) Der Name des Schlüssels.
  • options : (Objekt) Ein Objekt von Optionen. Die folgenden Objekteigenschaften sind gültig:
    • silent : Der Wert " true verhindert das Auslösen des data Ereignisses. Der Standardwert ist false .
  • value : (Object) Der Wert, der dem Schlüssel zugeordnet werden soll.
Rückgabe
Ein boolean Wert:
  • Der Wert true gibt an, dass das Datenobjekt gespeichert wurde.
  • Der Wert false gibt an, dass der Datenstore unverändert ist.

ContextHub.Store.JSONPStore

Ein Store, der JSON-Daten enthält. Die Daten werden von einem externen JSONP-Dienst oder optional von einem Dienst abgerufen, der JSON-Daten zurückgibt. Geben Sie die Details des Diensts mithilfe der init -Funktion an, wenn Sie eine Instanz dieser Klasse erstellen.
Der Store verwendet die speicherinterne Persistenz (JavaScript-Variable). Storedaten sind nur während der Lebensdauer der Seite verfügbar.
ContextHub.Store.JSONPStore extends ContextHub.Store.Core and inherits the functions of that class.

Funktionen (ContextHub.Store.JSONPStore)

configureService(serviceConfig, override)

Konfiguriert die Details für die Verbindung mit dem JSONP-Dienst, den dieses Objekt verwendet. Sie können entweder die vorhandene Konfiguration aktualisieren oder ersetzen. Die Funktion gibt keinen Wert zurück.
Parameter
  • serviceConfig : Ein Objekt, das folgende Eigenschaften enthält:
    • host : (String) Servernamen oder IP-Adresse.
    • jsonp : (Boolesch) Ein Wert „true“ zeigt an, dass der Service ein JSONP-Service ist, andernfalls ist er „false“. Falls „true“, {callback: "ContextHub.Callbacks. Object.name } Objekt wird dem service.params-Objekt hinzugefügt.
    • params : (Objekt) URL-Parameter, die als Objekteigenschaften dargestellt werden. Parameternamen sind Eigenschaftsnamen und Parameterwerte sind Eigenschaftswerte.
    • path : (String) Der Pfad zum Dienst.
    • port : (Number) Die Portnummer des Dienstes.
    • secure : (String oder Boolesch) Bestimmt das für die Service-URL zu verwendende Protokoll:
      • auto : //
      • true : https://
      • false : http://
  • override: (Boolesch). A value of true causes the existing service configuration to be replaced by the properties of serviceConfig . A value of false causes the existing service configuration properties to be merged with the properties of serviceConfig .

getRawResponse()

Gibt die unbearbeitete Antwort zurück, die seit dem letzten Aufruf des JSONP-Dienstes zwischengespeichert wurde. Die Funktion erfordert keine Parameter.
Rückgabe
Ein Objekt, das die unbearbeitete Antwort darstellt.

getServiceDetails()

Ruft das Dienstobjekt für dieses ContextHub.Store.JSONPStore-Objekt ab. Das Dienstobjekt enthält alle Informationen, die zum Erstellen der Service-URL erforderlich sind.
Rückgabe
Ein Objekt mit den folgenden Eigenschaften:
  • host : (String) Servernamen oder IP-Adresse.
  • jsonp : (Boolesch) Ein Wert true zeigt an, dass der Dienst ein JSONP-Dienst ist, andernfalls ist er false. Falls „true“, {callback: "ContextHub.Callbacks. Object.name } Objekt wird dem service.params-Objekt hinzugefügt.
  • params : (Objekt) URL-Parameter, die als Objekteigenschaften dargestellt werden. Parameternamen sind Eigenschaftsnamen und Parameterwerte sind Eigenschaftswerte.
  • path : (String) Der Pfad zum Dienst.
  • port : (Number) Die Portnummer des Dienstes.
  • secure : (String oder Boolesch) Bestimmt das für die Service-URL zu verwendende Protokoll:
    • auto : //
    • true : https://
    • false : http://

getServiceURL(resolve)

Ruft die URL des JSONP-Dienstes ab.
Parameter
  • resolve : (Boolesch) Bestimmt, ob aufgelöste Parameter in die URL aufgenommen werden sollen. A value of true resolves parameters, and false does not.
Rückgabe
Ein string -Wert, der die Dienst-URL darstellt.

init(name, config)

initializes the ContextHub.Store.JSONPStore object.
Parameter
  • name : (String) Der Name des Stores.
  • config : (Object) Ein Objekt, das die Service-Eigenschaft enthält. Das JSONPStore-Objekt verwendet die Eigenschaften des service objekts, um die URL des JSONP-Service zu erstellen:
    • eventDeferring : 32.
    • eventing : Das ContextHub.Utils.Eventing-Objekt für diesen Store. Der Standardwert ist das ContextHub.eventing -Objekt.
    • persistence : Das ContextHub.Utils.Persistence-Objekt für diesen Store. Standardmäßig wird die Storepersistenz verwendet (JavaScript-Objekt).
    • service : (Object)
      • host : (String) Servernamen oder IP-Adresse.
      • jsonp : (Boolesch) Ein Wert „true“ zeigt an, dass der Service ein JSONP-Service ist, andernfalls ist er „false“. Wenn "true", wird das {callback: "ContextHub.Callbacks.*Object.name*} Objekt service.params hinzugefügt.
      • params : (Objekt) URL-Parameter, die als Objekteigenschaften dargestellt werden. Parameternamen und Werte sind jeweils die Namen und Werte der Objekteigenschaften.
      • path : (String) Der Pfad zum Dienst.
      • port : (Number) Die Portnummer des Dienstes.
      • secure : (String oder Boolesch) Bestimmt das für die Service-URL zu verwendende Protokoll:
        • auto : //
        • true : https://
        • false : http://
      • timeout : (Number) Die Zeitspanne, die gewartet wird, bis der JSONP-Dienst vor Ablauf der Zeit reagiert (in Millisekunden).
        • ttl : Die Mindestdauer in Millisekunden, die zwischen Aufrufen an den JSONP-Dienst vergeht. (Siehe queryService Funktion).

queryService(reload)

Fragt den Remote-JSONP-Dienst ab und speichert die Antwort zwischen. If the amount of time since the previous call to this function is less than the value of config.service.ttl , the service is not called and the cached response is not changed. Optional können Sie den Dienst erzwingen aufgerufen zu werden. Die Eigenschaft config.service.ttl wird festgelegt, wenn die init -Funktion aufgerufen wird, um den Store zu initialisieren.
Löst das bereites Ereignis aus, wenn die Abfrage beendet ist. Wenn die JSONP-Service-URL nicht festgelegt ist, führt die Funktion nichts aus.
Parameter
  • reload : (Boolesch) Ein Wert „true“ entfernt die zwischengespeicherte Antwort und erzwingt den Aufruf des JSONP-Dienstes.

Zurücksetzen

Setzt die Anfangswerte der persistenten Daten des Stores zurück und ruft dann den JSONP-Dienst auf. Optional können Sie alle anderen Daten aus dem Store entfernen. Eventing wird für diesen Store angehalten, während die Anfangswerte zurückgesetzt werden. Diese Funktion gibt keinen Wert zurück.
Anfangswerte werden in der initialValues-Eigenschaft des config-Objekts bereitgestellt, das zum Instanziieren des Storeobjekts verwendet wird.
Parameter
  • keepRemainingData : (Boolesch) Ein Wert „true“ bewirkt, dass nicht-initial-Daten beibehalten werden. Der Wert „false“ bewirkt, dass alle Daten mit Ausnahme der Anfangswerte entfernt werden.

resolveParameter(f)

Löst den angegebenen Parameter auf.

ContextHub.Store.PersistedJSONPStore

ContextHub.Store.PersistedJSONPStore erweitert ContextHub.Store.JSONPStore so, dass es alle Funktionen dieser Klasse übernimmt. Die Daten, die vom JSONP-Dienst abgerufen werden, bleiben jedoch gemäß der Konfiguration der ContextHub-Persistenz bestehen. (See Persistence Modes: )

ContextHub.Store.PersistedStore

ContextHub.Store.PersistedStore erweitert ContextHub.Store.Core , sodass alle Funktionen dieser Klasse übernommen werden. Die Daten in diesem Store werden gemäß der Konfiguration der ContextHub-Persistenz beibehalten.

ContextHub.Store.SessionStore

ContextHub.Store.SessionStore erweitert ContextHub.Store.Core , sodass alle Funktionen dieser Klasse übernommen werden. Die Daten in diesem Store werden mithilfe der speicherinternen Persistenz beibehalten (JavaScript-Objekt).

ContextHub.UI

Verwaltet Benutzeroberflächenmodule und Benutzeroberflächenmodulrenderer.

Funktionen (ContextHub.UI)

registerRenderer(moduleType, renderer, dontRender)

Registriert einen Benutzeroberflächenmodulrenderer mit ContextHub. Nachdem der Renderer registriert ist, kann er verwendet werden, um Benutzeroberflächenmodule zu erstellen . Verwenden Sie diese Funktion, wenn Sie ContextHub.UI.BaseModuleRenderer erweitern, um einen benutzerdefinierten Benutzeroberflächenmodulrenderer zu erstellen.
Parameter
  • moduleType : (String) Die Kennung für den Benutzeroberflächenmodulrenderer. Wenn ein Renderer bereits mit dem angegebenen Wert registriert ist, wird der vorhandene Renderer nicht registriert, bevor dieser Renderer registriert wird.
  • renderer : (String) Der Name der Klasse, die das UI-Modul rendert.
  • dontRender : (Boolesch) Auf true gesetzt, um zu verhindern, dass die ContextHub-Benutzeroberfläche nach der Registrierung des Renderers gerendert wird. Der Standardwert ist false .
Beispiel
The following example registers a renderer as the contexthub.browserinfo module type.
ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

ContextHub.Utils.Eventing

Ermöglicht es Ihnen, Funktionen an ContextHub-Storeereignisse zu binden und zu lösen. Access ContextHub.Utils.Eventing objects for a store using the eventing property of the store.

Funktionen (ContextHub.Utils.Eventing)

off(name, selector)

Befreit eine Funktion aus einem Ereignis.
Parameter
  • name : Der Name des Ereignisses , für das Sie die Bindung der Funktion aufheben.
  • selector : Der Selektor, der die Bindung identifiziert. (Siehe den selector Parameter für die on und once Funktionen).
Rückgabe
Diese Funktion gibt keinen Wert zurück.

on(name, handler, selector, triggerForPastEvents)

Bindet eine Funktion an ein Ereignis. Die Funktion wird jedes Mal aufgerufen, wenn das Ereignis eintritt. Optional kann die Funktion für Ereignisse aufgerufen werden, die in der Vergangenheit stattgefunden haben, bevor die Bindung eingerichtet wird.
Parameter
  • name : (String) Der Name des Ereignisses , an das Sie die Funktion binden.
  • handler : (Funktion) Die Funktion zum Binden an das Ereignis.
  • selector : (String) Eine eindeutige Kennung für die Bindung. Sie benötigen den Selektor, um die Bindung zu identifizieren, wenn Sie die off -Funktion verwenden möchten, um die Bindung zu entfernen.
  • triggerForPastEvents : (Boolesch) Gibt an, ob der Handler für Ereignisse ausgeführt werden soll, die in der Vergangenheit aufgetreten sind. Ein Wert true ruft den Handler für vergangene Ereignisse auf. A value of false calls the handler for future events. Der Standardwert ist true .
Rückgabe
When the triggerForPastEvents argument is true , this function returns a boolean value that indicates whether the event occurred in the past:
  • true : Das Ereignis ist in der Vergangenheit aufgetreten und der Handler wird aufgerufen.
  • false : Das Ereignis ist nicht in der Vergangenheit aufgetreten.
If triggerForPastEvents is false , this function returns no value.
Beispiel
Im folgenden Beispiel wird eine Funktion an das Ereignis data des Geolocation Stores gebunden. Die Funktion füllt ein Element auf der Seite mit dem Wert für das Breitendatenelement des Speichers.
<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)

Bindet eine Funktion an ein Ereignis. Die Funktion wird nur einmal beim ersten Auftreten des Ereignisses aufgerufen. Optional kann die Funktion für das Ereignis aufgerufen werden, das in der Vergangenheit stattgefunden hat, bevor die Bindung hergestellt wird.
Parameter
  • name : (String) Der Name des Ereignisses , an das Sie die Funktion binden.
  • handler : (Funktion) Die Funktion zum Binden an das Ereignis.
  • selector : (String) Eine eindeutige Kennung für die Bindung. Sie benötigen den Selektor, um die Bindung zu identifizieren, wenn Sie die off -Funktion verwenden möchten, um die Bindung zu entfernen.
  • triggerForPastEvents : (Boolesch) Gibt an, ob der Handler für Ereignisse ausgeführt werden soll, die in der Vergangenheit aufgetreten sind. Ein Wert true ruft den Handler für vergangene Ereignisse auf. A value of false calls the handler for future events. Der Standardwert ist true .
Rückgabe
When the triggerForPastEvents argument is true , this function returns a boolean value that indicates whether the event occurred in the past:
  • true : Das Ereignis ist in der Vergangenheit aufgetreten und der Handler wird aufgerufen.
  • false : Das Ereignis ist nicht in der Vergangenheit aufgetreten.
If triggerForPastEvents is false , this function returns no value.

ContextHub.Utils.inheritance

Eine Dienstprogrammklasse, mit der ein Objekt die Eigenschaften und Methoden eines anderen Objekts übernehmen kann.

Funktionen (ContextHub.Utils.inheritance)

inherit(child, parent)

Bewirkt, dass ein Objekt die Eigenschaften und Methoden eines anderen Objekts übernimmt.
Parameter
  • child : (Object) Das Objekt, das übernimmt.
  • parent : (Object) Das Objekt, das die übernommenen Eigenschaften und Methoden definiert.

ContextHub.Utils.JSON

Stellt Funktionen zum Serialisieren von Objekten im JSON-Format und zum Deserialisieren von JSON-Strings in Objekten bereit.

Funktionen (ContextHub.Utils.JSON)

parse(data)

Analysiert einen String als JSON und konvertiert ihn in ein JavaScript-Objekt.
Parameter
  • data : Ein Stringwert im JSON-Format.
Rückgabe
Ein JavaScript-Objekt
Beispiel
Der Code:
ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}");

Gibt das folgende Objekt zurück:
Object {
   city: "Basel",
   country: "Switzerland",
   population: 173330
}

stringify(data)

Serialisiert JavaScript-Werte und -Objekte in Stringwerte des JSON-Formats.
Parameter
  • data : Der Wert oder das zu serialisierende Objekt. Diese Funktion unterstützt boolesche Werte, Array-, Zahlen-, String- und Datumswerte.
Rückgabe
Der serialisierte Stringwert. When data is a R egExp value, this function returns an empty object. When data is a function, returns undefined .
Beispiel
Der folgende Code:
ContextHub.Utils.JSON.stringify({
   city: "Basel",
   country: "Switzerland",
   population: 173330
});

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

ContextHub.Utils.JSON.tree

Diese Klasse erleichtert die Manipulation von Datenobjekten, die gespeichert oder aus ContextHub-Stores abgerufen werden.

Funktionen (ContextHub.Utils.JSON.tree)

addAllItems()

Erstellt eine Kopie eines Datenobjekts und fügt die Datenstruktur aus einem zweiten Objekt hinzu. Die Funktion gibt die Kopie zurück und ändert keines der ursprünglichen Objekte. Wenn die Datenbäume der beiden Objekte identische Schlüssel enthalten, überschreibt der Wert des zweiten Objekts den Wert des ersten Objekts.
Parameter
  • tree : Das kopierte Objekt.
  • secondTree : Das Objekt, das mit der Kopie des tree Objekts zusammengeführt wird.
Rückgabe
Ein Objekt, das die zusammengeführten Daten enthält.

cleanup()

Erstellt eine Kopie eines Objekts, sucht und entfernt Elemente in der Datenstruktur, die keine Werte, Nullwerte oder undefinierten Werte enthalten, und gibt die Kopie zurück.
Parameter
  • tree : Das zu bereinigende Objekt.
Rückgabe
Eine Kopie der Struktur, die bereinigt wird.

getItem()

Ruft den Wert eines Objekts für den a-Schlüssel ab.
Parameter
  • tree : Das data-Objekt.
  • key : Der Schlüssel für den Wert, den Sie abrufen möchten.
Rückgabe
Der Wert, der dem Schlüssel entspricht. Wenn der Schlüssel untergeordnete Schlüssel hat, gibt diese Funktion ein komplexes Objekt zurück. When the type of the value for the key is undefined , null is returned.
Beispiel
Betrachten Sie das folgende JavaScript-Objekt:
myObject {
  user: {
    location: {
      city: "Basel",
        details: {
          population: 173330,
          elevation: 260
        }
      }
    }
  }

Der folgende Beispiel-Code gibt den Wert 260 zurück.
ContextHub.Utils.JSON.tree.getItem(myObject, "/user/location/details/elevation");

Der folgende Beispiel-Code ruft den Wert für den Schlüssel zurück, der untergeordnete Schlüssel hat:
ContextHub.Utils.JSON.tree.getItem(myObject, "/user");

Die Funktion gibt das folgende Objekt zurück:
Object {
  location: {
    city: "Basel",
    details: {
      population: 173330,
      elevation: 260
    }
  }
}

getKeys()

Ruft alle Schlüssel aus der Datenstruktur eines Objekts ab. Optional können Sie nur die Schlüssel der untergeordneten Elemente eines bestimmten Schlüssels abrufen. Sie können optional auch eine Sortierreihenfolge der abgerufenen Schlüssel angeben.
Parameter
  • tree : Das Objekt, von dem die Schlüssel des Datenbaums abgerufen werden.
  • parent : (Optional) Der Schlüssel eines Elements im Datenbaum, für das Sie die Schlüssel der untergeordneten Elemente abrufen möchten.
  • order : (Optional) Eine Funktion, die die Sortierreihenfolge der zurückgegebenen Schlüssel bestimmt. (Siehe Array.prototype.sort im Mozilla Developer Network.)
Rückgabe
Ein Array von Schlüsseln.
Beispiel
Betrachten Sie das folgende Objekt:
myObject {
  location: {
    weather: {
      temperature: "28C",
      humidity: "77%",
      precipitation: "10%",
      wind: "8km/h"
    },
    city: "Basel",
    country: "Switzerland",
    longitude: 7.5925727,
    latitude: 47.557421
  }
}

The ContextHub.Utils.JSON.tree.getKeys(myObject); script returns the following 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()

Erstellt eine Kopie eines bestimmten Objekts, entfernt den angegebenen Zweig aus der Datenstruktur und gibt die geänderte Kopie zurück.
Parameter
  • tree : Ein Datenobjekt.
  • key : Der zu entfernende Schlüssel.
Rückgabe
Eine Kopie des ursprünglichen Datenobjekts mit entferntem Schlüssel.
Beispiel
Betrachten Sie das folgende Objekt:
myObject {
  one: {
    foo: "bar",
    two: {
      three: {
        four: {
          five: 5,
          six: 6
        }
      }
    }
  }
}

Das folgende Beispielskript entfernt den Zweig /one/two/three/four aus dem Datenbaum:
myObject = ContextHub.Utils.JSON.tree.removeItem(myObject, "/one/two/three/four");

Die Funktion gibt das folgende Objekt zurück:
myObject {
  one: {
    foo: "bar"
  }
}

sanitizeKey(key)

Bereinigt Stringwerte, um sie als Schlüssel nutzbar zu machen. Um einen String zu bereinigen, führt diese Funktion die folgenden Aktionen aus:
  • Reduziert mehrere aufeinander folgende Schrägstriche zu einem Schrägstrich.
  • Entfernt Leerzeichen am Anfang und am Ende des Strings.
  • Teilt das Ergebnis in ein Array von Strings auf, die durch Schrägstriche abgegrenzt sind.
Verwenden Sie das resultierende Array, um einen verwendbaren Schlüssel zu erstellen.
Parameter
  • key : Die string zu sanitisieren.
Rückgabe
An array of string values where each string is the portion of the key that was demarcated by slashes. stellt den bereinigten Schlüssel dar. Wenn das bereinigte Array eine Länge von hat, gibt diese Funktion null null zurück.
Beispiel
The following code sanitizes a string to produce the array ["this", "is", "a", "path"] , and then generates the key "/this/is/a/path" from the array:
var key = " / this////is/a/path ";
ContextHub.Utils.JSON.tree.sanitizeKey(key)
"/" + ContextHub.Utils.JSON.tree.sanitizeKey(key).join("/");

setItem(tree, key, value)

Fügt dem Datenbaum einer Kopie eines Objekts ein Schlüssel/Wert-Paar hinzu. For information about data trees, see Persistence.
Parameter
  • tree : Ein Datenobjekt.
  • key : Der Schlüssel, der mit dem hinzugefügten Wert verknüpft werden soll. Der Schlüssel ist der Pfad zum Element im Datenbaum. Diese Funktion ruft ContextHub.Utils.JSON.tree.sanitize auf, um den Schlüssel vor dem Hinzufügen zu bereinigen.
  • value : Der Wert, der dem Datenbaum hinzugefügt werden soll.
Rückgabe
A copy of the tree object that includes the key / value pair.
Beispiel
Betrachten Sie den folgenden JavaScript-Code:
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

Ermöglicht es Ihnen, Storekandidaten zu registrieren und registrierte Storekandidaten zu erhalten.

Funktionen (ContextHub.Utils.storeCandidates)

getRegisteredCandidates(storeType)

Gibt die Storetypen zurück, die als Storekandidaten registriert sind. Rufen Sie entweder die registrierten Bewerber eines bestimmten Store-Typs oder aller Store-Typen ab.
Parameter
Rückgabe
Ein Objekt von Storetypen. Die Objekteigenschaften sind die Namen des Storetyps, und die Eigenschaftswerte sind ein Array von registrierten Storekandidaten.

getStoreFromCandidates(storeType)

Gibt einen Storetyp aus den registrierten Kandidaten zurück. Wenn mehrere Speichertypen mit demselben Namen registriert sind, gibt die Funktion den Speichertyp mit der höchsten Priorität zurück.
Parameter
Rückgabe
Ein Objekt, das den registrierten Storekandidaten darstellt. Wenn der angeforderte Storetyp nicht registriert ist, wird ein Fehler ausgelöst.

getSupportedStoreTypes()

Gibt die Namen der Storetypen zurück, die als Storekandidaten registriert sind. Diese Funktion erfordert keine Parameter.
Rückgabe
Ein Array von Stringwerten, wobei jeder String der Storetyp ist, mit dem ein Storekandidat registriert wurde. See the storeType parameter of the ContextHub.Utils.storeCandidates.registerStoreCandidate function.

registerStoreCandidate(store, storeType, priority, applies)

Registriert ein Storeobjekt als einen Storekandidaten unter Verwendung eines Namens und einer Priorität.
Die Priorität ist eine Zahl, die die Bedeutung der gleichnamigen Store angibt. Wenn ein Storekandidat unter Verwendung des gleichen Namens wie ein bereits registrierter Storekandidat registriert wird, wird der Kandidat mit der höheren Priorität verwendet. Bei der Registrierung eines Storekandidaten wird der Store nur registriert, wenn die Priorität höher ist als bei den gleichnamigen registrierten Storekandidaten.
Parameter
  • store : (Objekt) Das Storeobjekt, das als Storekandidat registriert werden soll.
  • storeType : (String) Der Name des Storekandidaten. Dieser Wert wird beim Erstellen einer Instanz des Storekandidaten benötigt.
  • priority : (Number) Die Priorität des Store-Kandidaten.
  • applies : (Funktion) Die aufzurufende Funktion, die die Anwendbarkeit des Speichers in der aktuellen Umgebung auswertet. Die Funktion muss true zurückgeben, wenn der Store anwendbar ist, andernfalls false . The default value is a function that returns true: function() {return true;}
Beispiel
ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandiate', 0);