Guide de référence pour l’API JavaScript ContextHub contexthub-javascript-api-reference

L’API JavaScript ContextHub est disponible pour les scripts lorsque le composant ContextHub a été ajouté à la page.

Constantes ContextHub contexthub-constants

Valeurs constantes définies par l’API JavaScript ContextHub.

Constantes d’événement event-constants

Le tableau suivant répertorie les noms des événements qui se produisent pour les magasins ContextHub. Voir aussi ContextHub.Utils.Eventing.

Constantes d’événement de l’IU ui-event-constants

Le tableau suivant répertorie les noms des événements qui se produisent pour l’IU ContextHub.

Guide de référence pour l’API JavaScript ContextHub contexthub-javascript-api-reference-2

L’objet ContextHub fournit l’accès à tous les magasins.

Fonctions (ContextHub) functions-contexthub

getAllStores() getallstores

Renvoie tous les magasins ContextHub enregistrés.

Cette fonction ne comporte aucun paramètre.

Renvoie

Un objet qui contient tous les magasins ContextHub. Chaque magasin est un objet qui porte le même nom que le magasin.

Exemple

L’exemple suivant récupère tous les magasins, puis récupère le magasin de géolocalisation :

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

getStore(name) getstore-name

Récupère un magasin en tant qu’objet JavaScript.

Paramètres

Renvoie

Un objet qui représente le magasin.

Exemple

L’exemple suivant récupère le magasin de géolocalisation :

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

ContextHub.SegmentEngine.Segment contexthub-segmentengine-segment

Représente un segment ContextHub. Utilisez ContextHub.SegmentEngine.SegmentManager pour obtenir des segments.

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

getName() getname

Renvoie le nom du segment sous la forme d’une valeur String .

getPath() getpath

Renvoie le chemin du référentiel de la définition de segment sous la forme d’une valeur String .

ContextHub.SegmentEngine.SegmentManager contexthub-segmentengine-segmentmanager

Fournit un accès aux segments ContextHub.

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

getResolvedSegments() getresolvedsegments

Renvoie les segments résolus dans le contexte actuel. Cette fonction ne comporte aucun paramètre.

Renvoie

Tableau d’objets ContextHub.SegmentEngine.Segment .

ContextHub.Store.Core contexthub-store-core

Classe de base pour les magasins ContextHub.

Propriétés (ContextHub.Store.Core) properties-contexthub-store-core

eventing eventing

Objet ContextHub.Utils.Eventing. Utilisez cet objet pour que les fonctions de liaison stockent les événements. Pour plus d’informations sur la valeur par défaut et l’initialisation, consultez init(name,config).

name name

Nom du magasin

persistence persistence

Objet ContextHub.Utils.Persistence. Pour plus d’informations sur la valeur par défaut et l’initialisation, consultez init(name,config)…

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

addAllItems(tree, options) addallitems-tree-options

Fusionne un objet de données ou un tableau contenant les données de magasin. Chaque paire clé/valeur de l’objet ou du tableau est ajoutée au magasin (via la fonction setItem) :

Notez que les valeurs peuvent être des objets.

Paramètres

Renvoie

Une valeur boolean :

addReference(key, anotherKey) addreference-key-anotherkey

Crée une référence d’une clé à une autre. Une clé ne peut pas se référencer.

Paramètres

Renvoie

Une valeur boolean :

announceReadiness() announcereadiness

Déclenche l’événement ready pour ce magasin. Cette fonction ne comporte aucun paramètre et ne renvoie aucune valeur.

clean() clean

Supprime toutes les données du magasin. La fonction ne comporte aucun paramètre et aucune valeur renvoyée.

getItem(key) getitem-key

Renvoie la valeur associée à une clé.

Paramètres

Renvoie

Un objet qui représente la valeur de la clé.

getKeys(includeInternals) getkeys-includeinternals

Récupère les clés du magasin. Vous pouvez éventuellement récupérer les clés utilisées en interne par la structure ContextHub.

Paramètres

Renvoie

Tableau de noms de clés (valeurs string).

getReferences() getreferences

Récupère les références du magasin.

Renvoie

Tableau qui utilise des clés de référencement comme index des clés référencées :

getTree(includeInternals) gettree-includeinternals

Récupère l’arbre de données du magasin. Vous pouvez éventuellement inclure les paires clé/valeur utilisées en interne par la structure ContextHub.

Paramètres

Renvoie

Un objet qui représente l’arbre de données. Les clés sont les noms des propriétés de l’objet.

init(name, config) init-name-config

Initialise le magasin.

Paramètres

isEventingPaused() iseventingpaused

Détermine si le déclenchement d’événement est suspendu pour ce magasin.

Renvoie

Une valeur booléenne :

pauseEventing() pauseeventing

Suspend le mode Eventing pour le magasin afin qu’aucun événement ne soit déclenché. Cette fonction ne nécessite aucun paramètre et ne renvoie aucune valeur.

removeItem(key, options) removeitem-key-options

Supprime une paire clé/valeur du magasin.

Lorsqu’une clé est supprimée, la fonction déclenche l’événement data. Les données d’événement incluent le nom du magasin, le nom de la clé qui a été supprimée, la valeur qui a été supprimée, la nouvelle valeur pour la clé (null) et le type d’action « remove ».

En option, vous pouvez empêcher le déclenchement de l’événement data.

Paramètres

Renvoie

Une valeur boolean :

removeReference(key) removereference-key

Supprime une référence du magasin.

Paramètres

Renvoie

Une valeur boolean :

reset(keepRemainingData) reset-keepremainingdata

Rétablit les valeurs d’origine des données persistantes du magasin. En option, vous pouvez supprimer toutes les autres données du magasin. L’événement est suspendu pour ce magasin pendant sa réinitialisation. Cette fonction ne renvoie aucune valeur.

Les valeurs initiales sont fournies dans la propriété initialValues de l’objet de configuration utilisé pour instancier l’objet magasin.

Paramètres

Rétablit les valeurs d’origine des données persistantes du magasin. En option, vous pouvez supprimer toutes les autres données du magasin. L’événement est suspendu pour ce magasin pendant sa réinitialisation. Cette fonction ne renvoie aucune valeur.

Les valeurs initiales sont fournies dans la propriété initialValues de l’objet de configuration utilisé pour instancier l’objet magasin.

Paramètres

resolveReference(key, retry) resolvereference-key-retry

Récupère une clé référencée. Vous pouvez éventuellement spécifier le nombre d’itérations à utiliser pour résoudre la meilleure correspondance.

Paramètres

Renvoie

Valeur string représentant la clé référencée. Si aucune référence n’est résolue, la valeur du paramètre key est renvoyée.

resumeEventing() resumeeventing

Rétablit le mode Eventing pour ce magasin afin que les événements soient déclenchés. Cette fonction ne définit aucun paramètre et ne renvoie aucune valeur.

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

Ajoute une paire clé/valeur au magasin.

Déclenche l’événement data uniquement si la valeur de la clé est différente de la valeur actuellement stockée pour la clé. Vous pouvez éventuellement empêcher le déclenchement de l’événement data.

Les données d’événement incluent le nom du magasin, la clé, la valeur précédente, la nouvelle valeur et le type d’action set.

Paramètres

Renvoie

Une valeur boolean :

ContextHub.Store.JSONPStore contexthub-store-jsonpstore

Un magasin contenant des données JSON. Les données sont extraites d’un service JSONP externe ou, facultativement, d’un service qui renvoie des données JSON. Spécifiez les détails du service à l’aide de la fonction init lorsque vous créez une instance de cette classe.

Le magasin utilise la persistance en mémoire (variable JavaScript). Les données de magasin sont disponibles uniquement pendant la durée de vie de la page.

ContextHub.Store.JSONPStore étend ContextHub.Store.Core et hérite des fonctions de cette classe.

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

configureService(serviceConfig, override) configureservice-serviceconfig-override

Configure les détails de connexion au service JSONP que cet objet utilise. Vous pouvez mettre à jour ou remplacer la configuration existante. La fonction ne renvoie aucune valeur.

Paramètres

getRawResponse() getrawresponse

Renvoie la réponse brute mise en cache depuis le dernier appel au service JSONP. La fonction ne nécessite aucun paramètre.

Renvoie

Objet représentant la réponse brute.

getServiceDetails() getservicedetails

Récupère l’objet de service pour cet objet ContextHub.Store.JSONPStore. L’objet service contient toutes les informations requises pour créer l’URL du service.

Renvoie

Un objet possédant les propriétés suivantes :

getServiceURL(resolve) getserviceurl-resolve

Récupère l’URL du service JSONP.

Paramètres

Renvoie

Une valeur string représentant l’URL du service.

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

initialise l’objet ContextHub.Store.JSONPStore .

Paramètres

queryService(reload) queryservice-reload

Interroge le service JSONP distant et met en cache la réponse. Si la durée écoulée depuis l’appel précédent à cette fonction est inférieure à la valeur de config.service.ttl, le service n’est pas appelé et la réponse mise en cache n’est pas modifiée. En option, vous pouvez forcer l’appel du service. La propriété config.service.ttl est définie lors de l’appel de la fonction init pour initialiser le magasin.

Déclenche l’événement ready lorsque la requête est terminée. Si l’URL du service JSONP n’est pas définie, la fonction ne fait rien.

Paramètres

reset reset

Réinitialise les valeurs initiales des données persistantes du magasin, puis appelle le service JSONP. En option, vous pouvez supprimer toutes les autres données du magasin. L’événement est suspendu pour ce magasin pendant que les valeurs initiales sont réinitialisées. Cette fonction ne renvoie aucune valeur.

Les valeurs initiales sont fournies dans la propriété initialValues de l’objet de configuration utilisé pour instancier l’objet magasin.

Paramètres

resolveParameter(f) resolveparameter-f

Résout le paramètre donné.

ContextHub.Store.PersistedJSONPStore contexthub-store-persistedjsonpstore

ContextHub.Store.PersistedJSONPStore étend le paramètre ContextHub.Store.JSONPStore pour qu’il hérite de toutes les fonctions de cette classe. Toutefois, les données extraites du service JSONP sont conservées conformément à la configuration de la persistance ContextHub. (Consultez Modes de persistance.)

ContextHub.Store.PersistedStore contexthub-store-persistedstore

ContextHub.Store.PersistedStore étend ContextHub.Store.Core pour qu’il hérite de toutes les fonctions de cette classe. Les données de ce magasin sont conservées en fonction de la configuration de la persistance ContextHub.

ContextHub.Store.SessionStore contexthub-store-sessionstore

ContextHub.Store.SessionStore étend ContextHub.Store.Core pour qu’il hérite de toutes les fonctions de cette classe. Les données de ce magasin sont conservées en utilisant la persistance en mémoire (objet JavaScript).

ContextHub.UI contexthub-ui

Gère les modules d’IU et les moteurs de rendu des modules d’IU.

Fonctions (ContextHub.UI) functions-contexthub-ui

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

Enregistre un moteur de rendu de module d’IU avec ContextHub. Une fois le moteur de rendu enregistré, il peut être utilisé pour créer des modules d’IU. Utilisez cette fonction lorsque vous extension de ContextHub.UI.BaseModuleRenderer pour créer un moteur de rendu de module d’IU personnalisé.

Paramètres

Exemple

L’exemple suivant enregistre un moteur de rendu en tant que type de module contexthub.browserinfo .

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

ContextHub.Utils.Cookie contexthub-utils-cookie

Classe d’utilitaire permettant d’interagir avec les cookies.

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

exists(key) exists-key

Détermine si un cookie existe.

Paramètres

Renvoie

Une valeur boolean true indique que le cookie existe.

Exemple

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

getAllItems(filter) getallitems-filter

Renvoie tous les cookies dont les clés correspondent à un filtre.

Paramètres

Renvoie

Un objet de cookies. Les propriétés de l’objet sont des clés de cookie et les valeurs de clé sont des valeurs de cookie.

Exemple

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

getItem(key) getitem-key-1

Renvoie une valeur de cookie.

Paramètres

Renvoie

La valeur du cookie ou la valeur null si aucun cookie n’a été identifié pour la clé.

Exemple

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

getKeys(filter) getkeys-filter

Renvoie un tableau des clés des cookies existants correspondant à un filtre.

Paramètres

Renvoie

Un tableau de chaînes où chaque chaîne est la clé d’un cookie qui répond aux critères du filtre.

Exemple

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

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

Supprime un cookie. Pour supprimer le cookie, la valeur est définie sur une chaîne vide et la date d’expiration est définie sur le jour précédant la date actuelle.

Paramètres

Renvoie

Cette fonction ne retourne pas de valeur.

Exemple

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

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

Crée un cookie de la clé et de la valeur en question et ajoute le cookie au document en cours. Vous pouvez éventuellement spécifier des options qui configurent les attributs du cookie.

Paramètres

Renvoie

Le cookie avec la valeur définie.

Exemple

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

vanish(filter, options) vanish-filter-options

Supprime tous les cookies répondant aux critères d’un filtre donné. Les cookies sont mis en correspondance à l’aide de la fonction getKeys et supprimés à l’aide de la fonction removeItem .

Paramètres

Renvoie

Cette fonction ne retourne pas de valeur.

ContextHub.Utils.Eventing contexthub-utils-eventing

Vous permet d’associer et de dissocier des fonctions aux événements du magasin ContextHub. Accédez aux objets ContextHub.Utils.Eventing d’un magasin à l’aide de la propriété eventing de la boutique.

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

off(name, selector) off-name-selector

Dissocie une fonction d’un événement.

Paramètres

Renvoie

Cette fonction ne renvoie aucune valeur.

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

Associe une fonction à un événement. La fonction est appelée à chaque fois que l’événement se produit. Vous pouvez éventuellement appeler la fonction pour les événements survenus dans le passé, avant que la liaison ne soit établie.

Paramètres

Renvoie

Lorsque l’argument triggerForPastEvents est défini sur true, cette fonction renvoie une valeur boolean qui indique si l’événement s’est déjà produit :

Si triggerForPastEvents est défini sur false, cette fonction ne renvoie aucune valeur.

Exemple

L’exemple suivant associe une fonction à l’événement de données du magasin de géolocalisation. La fonction remplit un élément sur la page avec la valeur de l’élément de données de latitude du magasin.

<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

Associe une fonction à un événement. La fonction est appelée une seule fois, pour la première occurrence de l’événement. Vous pouvez éventuellement appeler la fonction pour l’événement qui s’est produit dans le passé, avant que la liaison ne soit établie.

Paramètres

Renvoie

Lorsque l’argument triggerForPastEvents est défini sur true, cette fonction renvoie une valeur boolean qui indique si l’événement s’est déjà produit :

Si triggerForPastEvents est défini sur false, cette fonction ne renvoie aucune valeur.

ContextHub.Utils.inheritance contexthub-utils-inheritance

Classe d’utilitaire qui permet à un objet d’hériter des propriétés et des méthodes d’un autre objet.

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

inherit(child, parent) inherit-child-parent

Permet à l’objet d’hériter des propriétés et des méthodes d’un autre objet.

Paramètres

ContextHub.Utils.JSON contexthub-utils-json

Fournit des fonctions pour sérialiser les objets au format JSON et désérialiser des chaînes JSON en objets.

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

parse(data) parse-data

Analyse une valeur de chaîne au format JSON et la convertit en objet JavaScript.

Paramètres

Renvoie

Un objet JavaScript.

Exemple

Le code ContextHub.Utils.JSON.parse("{'city':'Basel','country':'Switzerland','population':'173330'}"); renvoie l’objet suivant :

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

stringify(data) stringify-data

Sérialise les valeurs JavaScript et les objets en valeurs de chaîne au format JSON.

Paramètres

Renvoie

La valeur de chaîne sérialisée. Lorsque data est une valeur R egExp, cette fonction renvoie un objet vide. Lorsque data est une fonction, renvoie undefined.

Exemple

Le code suivant renvoie "{'city':'Basel','country':'Switzerland','population':'173330'}":.

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

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

Cette classe facilite la manipulation des objets de données à stocker ou à extraire des magasins ContextHub.

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

addAllItems() addallitems

Crée une copie d’un objet de données et y ajoute l’arbre de données d’un second objet. La fonction renvoie la copie et ne modifie aucun des objets d’origine. Lorsque les arborescences de données des deux objets contiennent des clés identiques, la valeur du deuxième objet remplace la valeur du premier objet.

Paramètres

Renvoie

Objet contenant les données fusionnées.

cleanup() cleanup

Crée une copie d’un objet, identifie et supprime les éléments de l’arbre de données qui ne contiennent aucune valeur, une valeur nulle ou indéfinie et renvoie la copie.

Paramètres

Renvoie

Une copie de l’arborescence qui est nettoyée.

getItem() getitem

Récupère la valeur d’un objet pour une clé donnée.

Paramètres

Renvoie

La valeur qui correspond à la clé. Si la clé possède des clés enfants, cette fonction renvoie un objet complexe. Lorsque le type de la valeur de la clé est undefined, la valeur null est renvoyée.

Exemple

Étudions l’objet JavaScript suivant :

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

L’exemple de code suivant renvoie la valeur 260 :

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

L’exemple de code suivant récupère la valeur d’une clé possédant des clés enfants :

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

La fonction renvoie l’objet suivant :

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

getKeys() getkeys

Récupère toutes les clés de l’arbre de données d’un objet. En option, vous pouvez récupérer uniquement les clés des enfants d’une clé spécifique. Vous pouvez également spécifier un ordre de tri des clés récupérées.

Paramètres

Renvoie

Un tableau de clés.

Exemple

Étudions l’objet suivant :

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

Le script ContextHub.Utils.JSON.tree.getKeys(myObject); renvoie le tableau suivant :

["/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

Crée une copie d’un objet donné, supprime la branche spécifiée de l’arbre de données et renvoie la copie modifiée.

Paramètres

Renvoie

Une copie de l’objet de données d’origine avec la clé supprimée.

Exemple

Étudions l’objet suivant :

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

L’exemple de script suivant supprime la branche /un/deux/trois/quatre de l’arborescence de données :

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

La fonction renvoie l’objet suivant :

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

sanitizeKey(key) sanitizekey-key

Assainit les valeurs de chaîne pour les rendre utilisables sous forme de clés. Pour assainir une chaîne, cette fonction effectue les actions suivantes :

Utilisez le tableau obtenu pour créer une clé utilisable. Paramètres

Renvoie

Un tableau de valeurs string où chaque chaîne est la partie de la key délimitée par des barres obliques. représente la clé assainie. Si le tableau assaini a une longueur égale à zéro, cette fonction renvoie la valeur null.

Exemple

Le code suivant assainit une chaîne pour générer le tableau ["this", "is", "a", "path"], puis génère la clé "/this/is/a/path" à partir du tableau :

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

Ajoute une paire clé/valeur à l’arbre de données d’une copie d’un objet. Pour plus d’informations sur les arbres de données, consultez Persistance.

Paramètres

Renvoie

Une copie de l’objet tree qui comporte la paire key/value.

Exemple

Étudions le code JavaScript suivant :

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

L’objet myObject a la valeur suivante :

ContextHub.Utils.storeCandidates contexthub-utils-storecandidates

Vous permet d’enregistrer des magasins candidats et de récupérer les candidats enregistrés.

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

getRegisteredCandidates(storeType) getregisteredcandidates-storetype

Renvoie les types de magasins enregistrés en tant que magasins candidats. Récupérez les candicates enregistrés d’un type de magasin spécifique ou de tous les types de magasin.

Paramètres

Renvoie

Un objet de types de magasin. Les propriétés de l’objet sont les noms des types de magasin et les valeurs de propriété sont un tableau des magasins candidats enregistrés.

getStoreFromCandidates(storeType) getstorefromcandidates-storetype

Renvoie un type de magasin parmi les candidats enregistrés. Si plusieurs types de magasin du même nom sont enregistrés, la fonction renvoie le type de magasin ayant la priorité la plus élevée.

Paramètres

Renvoie

Un objet qui représente le magasin candidat enregistré. Si le type de magasin demandé n’est pas enregistré, une erreur est générée.

getSupportedStoreTypes() getsupportedstoretypes

Renvoie les noms des magasins enregistrés en tant que magasins candidats. Cette fonction ne nécessite aucun paramètre.

Renvoie

Un tableau de valeurs sous forme de chaîne où chaque chaîne correspond au type de magasin avec lequel un magasin candidat a été enregistré. Voir le paramètre storeType de la fonction .ContextHub.Utils.storeCandidates.registerStoreCandidate

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

Enregistre un objet magasin en tant que magasin candidat à l’aide d’un nom et d’une priorité.

La priorité est un nombre qui indique l’importance des magasins de même nom. Lorsqu’un magasin candidat est enregistré sous le même nom qu’un magasin candidat déjà enregistré, le candidat ayant la priorité la plus élevée est utilisé. Lors de l’enregistrement d’un candidat de magasin, le magasin n’est enregistré que si la priorité est supérieure aux candidats de magasin enregistrés portant le même nom.

Paramètres

Exemple

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