IExtensionDataManager interface
Méthodes
| create |
Renvoie une promesse de création d’un document dans la collection fournie |
| delete |
Renvoie une promesse de suppression du document à la portée, à la collection et à l’id fournis |
| get |
Renvoie une promesse d’obtention d’un document avec l’id fourni dans la collection fournie |
| get |
Renvoie une promesse d’obtention de tous les documents de la collection fournie |
| get |
Renvoie une promesse pour la récupération d’un paramètre à la clé et à la portée fournies |
| query |
Renvoie une promesse pour l’interrogation d’un ensemble de collections |
| query |
Renvoie une promesse pour l’interrogation d’un ensemble de collections |
| set |
Renvoie une promesse de définition d’un document dans la collection fournie Crée le document s’il n’existe pas, sinon met à jour le document existant avec l’id fourni |
| set |
Renvoie une promesse d’enregistrement d’un paramètre à la clé et à la portée fournies |
| update |
Renvoie une promesse de mise à jour d’un document dans la collection fournie Un document avec l’id fourni doit exister |
Détails de la méthode
createDocument(string, any, IDocumentOptions)
Renvoie une promesse de création d’un document dans la collection fournie
function createDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>Paramètres
- collectionName
-
string
Nom de la collection dans laquelle se trouve le document
- doc
-
any
Le document à stocker
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<any>
deleteDocument(string, string, IDocumentOptions)
Renvoie une promesse de suppression du document à la portée, à la collection et à l’id fournis
function deleteDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<void>Paramètres
- collectionName
-
string
Nom de la collection dans laquelle se trouve le document
- id
-
string
L’identifiant du document dans la collection
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<void>
getDocument(string, string, IDocumentOptions)
Renvoie une promesse d’obtention d’un document avec l’id fourni dans la collection fournie
function getDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<any>Paramètres
- collectionName
-
string
Nom de la collection dans laquelle se trouve le document
- id
-
string
L’identifiant du document dans la collection
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<any>
getDocuments(string, IDocumentOptions)
Renvoie une promesse d’obtention de tous les documents de la collection fournie
function getDocuments(collectionName: string, documentOptions?: IDocumentOptions): Promise<any[]>Paramètres
- collectionName
-
string
Nom de la collection dans laquelle se trouve le document
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<any[]>
getValue<T>(string, IDocumentOptions)
Renvoie une promesse pour la récupération d’un paramètre à la clé et à la portée fournies
function getValue<T>(key: string, documentOptions?: IDocumentOptions): Promise<T>Paramètres
- key
-
string
La clé pour récupérer une valeur
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<T>
queryCollections(ExtensionDataCollection[])
Renvoie une promesse pour l’interrogation d’un ensemble de collections
function queryCollections(collections: ExtensionDataCollection[]): Promise<ExtensionDataCollection[]>Paramètres
- collections
La liste des collections à interroger. Chaque collection contiendra son collectionName, scopeType et scopeValue
Retours
Promise<ExtensionDataCollection[]>
queryCollectionsByName(string[])
Renvoie une promesse pour l’interrogation d’un ensemble de collections
function queryCollectionsByName(collectionNames: string[]): Promise<ExtensionDataCollection[]>Paramètres
- collectionNames
-
string[]
Retours
Promise<ExtensionDataCollection[]>
setDocument(string, any, IDocumentOptions)
Renvoie une promesse de définition d’un document dans la collection fournie Crée le document s’il n’existe pas, sinon met à jour le document existant avec l’id fourni
function setDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>Paramètres
- collectionName
-
string
Nom de la collection dans laquelle se trouve le document
- doc
-
any
Le document à stocker
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<any>
setValue<T>(string, T, IDocumentOptions)
Renvoie une promesse d’enregistrement d’un paramètre à la clé et à la portée fournies
function setValue<T>(key: string, value: T, documentOptions?: IDocumentOptions): Promise<T>Paramètres
- key
-
string
La clé pour laquelle enregistrer une valeur
- value
-
T
La valeur à économiser
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<T>
updateDocument(string, any, IDocumentOptions)
Renvoie une promesse de mise à jour d’un document dans la collection fournie Un document avec l’id fourni doit exister
function updateDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>Paramètres
- collectionName
-
string
Nom de la collection dans laquelle se trouve le document
- doc
-
any
Le document à stocker
- documentOptions
- IDocumentOptions
Options du document d’extension, la valeur par défaut de l’étendue est à l’échelle du compte
Retours
Promise<any>