Erweitern von ContextHub

Definieren Sie neue Typen von ContextHub-Stores und -Modulen, wenn die bereitgestellten Typen nicht Ihren Lösungsanforderungen entsprechen.

Erstellen benutzerdefinierter Store-Kandidaten

ContextHub-Stores werden aus registrierten Store-Kandidaten erstellt. Um einen benutzerdefinierten Store zu erstellen, erstellen und registrieren Sie einen Store-Kandidaten.

Die JavaScript-Datei, die den Code enthält, der den Store-Kandidaten erstellt und registriert, muss in einer Client-Bibliotheksordner. Die Ordnerkategorie muss dem folgenden Muster entsprechen:

contexthub.store.[storeType]

Beim [storeType]-Teil der Kategorie handelt es sich um den storeType, mit dem der Store-Kandidat registriert wird. (Siehe Registrieren von ContextHub-Store-Kandidaten.) Beispielsweise muss für den Store-Typ contexthub.mystore die Kategorie des Client-Bibliotheksordners contexthub.store.contexthub.mystore lauten.

Erstellen von ContextHub-Store-Kandidaten

Verwenden Sie zum Erstellen eines Store-Kandidaten die Funktion ContextHub.Utils.inheritance.inherit, um einen der grundlegenden Stores zu erweitern:

Jeder Basisspeicher erweitert die ContextHub.Store.Core speichern.

Im folgenden Beispiel wird erst die einfachste Erweiterung des Store-Kandidaten ContextHub.Store.PersistedStore erstellt:

myStoreCandidate = function(){};
ContextHub.Utils.inheritance.inherit(myStoreCandidate,ContextHub.Store.PersistedStore);

In der Praxis definieren Ihre benutzerdefinierten Store-Kandidaten zusätzliche Funktionen oder überschreiben die anfängliche Konfiguration des Stores. Mehrere Beispiel-Store-Kandidaten werden im Repository unter /libs/granite/contexthub/components/stores installiert. Um von diesen Beispielen zu lernen, verwenden Sie CRXDE Lite zum Öffnen der JavaScript-Dateien.

Registrieren von ContextHub-Store-Kandidaten

Registrieren Sie einen Store-Kandidaten, um ihn mit dem ContextHub-Framework zu integrieren und Stores zu aktivieren, die auf Grundlage des Kandidaten erstellt werden sollen. Um einen Store-Kandidaten zu registrieren, verwenden Sie die Funktion registerStoreCandidate der Klasse ContextHub.Utils.storeCandidates.

Wenn Sie einen Store-Kandidaten registrieren, geben Sie einen Namen für den Store-Typ an. Beim Erstellen eines Stores auf Grundlage des Kandidaten identifizieren Sie über den Store-Typ den zugrunde liegenden Kandidaten.

Geben Sie beim Registrieren eines Store-Kandidaten dessen Priorität an. Wird ein Store-Kandidat mit demselben Store-Typ wie ein bereits registrierter Store-Kandidat registriert, wird der Kandidat mit der höheren Priorität verwendet. Daher können Sie vorhandene Store-Kandidaten durch neue Implementierungen überschreiben.

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

Normalerweise ist nur ein Kandidat erforderlich und die Priorität kann auf 0. Aber wenn Sie daran interessiert sind, können Sie erweiterte Registrierungen, , mit der eine oder mehrere Store-Implementierungen basierend auf der JavaScript-Bedingung ausgewählt werden können (applies) und der Kandidatenpriorität.

Erstellen von Typen von ContextHub-Benutzeroberflächenmodulen

Erstellen Sie benutzerdefinierte Typen eines Benutzeroberflächenmoduls, wenn die mit ContextHub installierten Typen nicht Ihren Anforderungen entsprechen. Um einen UI-Modultyp zu erstellen, erstellen Sie einen Benutzeroberflächenmodul-Renderer, indem Sie die ContextHub.UI.BaseModuleRenderer und dann mit ContextHub.UI.

Erstellen Sie zum Erstellen eines Benutzeroberflächenmodul-Renderers ein Class-Objekt, das die Logik enthält, die das Benutzeroberflächenmodul rendert. Ihre Klasse muss mindestens die folgenden Aktionen durchführen:

Erweitern der ContextHub.UI.BaseModuleRenderer-Klasse. Bei dieser Klasse handelt es sich um die Basisimplementierung für alle Benutzeroberflächenmodul-Renderer. Das Class-Objekt definiert eine Eigenschaft namens extend, mit der Sie diese Klasse als diejenige benennen, die erweitert wird.
Bereitstellen einer Standardkonfiguration. Erstellen Sie eine Eigenschaft defaultConfig. Diese Eigenschaft ist ein Objekt, das die Eigenschaften enthält, die für das Benutzeroberflächenmodul contexthub.base definiert sind, sowie alle anderen Eigenschaften, die Sie benötigen.

Die Quelle für ContextHub.UI.BaseModuleRenderer befindet sich unter /libs/granite/contexthub/code/ui/container/js/ContextHub.UI.BaseModuleRenderer.js. Verwenden Sie zum Registrieren des Renderers die Methode registerRenderer der ContextHub.UI-Klasse. Geben Sie einen Namen für den Modultyp an. Wenn Administratoren ein Benutzeroberflächenmodul auf Grundlage dieses Renderers erstellen, geben sie diesen Namen an.

Erstellen und registrieren Sie die Renderer-Klasse in einer selbstausführenden anonymen Funktion. Das folgende Beispiel basiert auf dem Quellcode für das Benutzeroberflächenmodul contexthub.browserinfo. Dieses Benutzeroberflächenmodul ist eine einfache Erweiterung der ContextHub.UI.BaseModuleRenderer-Klasse.

;(function() {

    var SurferinfoRenderer = new Class({
        extend: ContextHub.UI.BaseModuleRenderer,

        defaultConfig: {
            icon: 'coral-Icon--globe',
            title: 'Browser/OS Information',

            storeMapping: {
                surferinfo: 'surferinfo'
            },

            template:
                '<p>{{surferinfo.browser.family}} {{surferinfo.browser.version}}</p>' +
                '<p>{{surferinfo.os.name}} {{surferinfo.os.version}}</p>'
        }
    });

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

}());

Die JavaScript-Datei, die den Code enthält, der den Renderer erstellt und registriert, muss in einer Client-Bibliotheksordner. Die Ordnerkategorie muss dem folgenden Muster entsprechen:

contexthub.module.[moduleType]

Beim [moduleType]-Teil der Kategorie handelt es sich um den moduleType, mit dem der Renderer registriert wird. Beispielsweise muss für den moduleType von contexthub.browserinfo die Kategorie des Client-Bibliotheksordners contexthub.module.contexthub.browserinfo lauten.