IExtensionDataManager interface
Methoden
| create |
Retourneert een belofte voor het maken van een document in de opgegeven verzameling |
| delete |
Retourneert een belofte voor het verwijderen van het document binnen het opgegeven bereik, verzameling en id |
| get |
Retourneert een belofte voor het verkrijgen van een document met de opgegeven id in de opgegeven verzameling |
| get |
Retourneert een belofte voor het verkrijgen van alle documenten in de meegeleverde collectie |
| get |
Retourneert een belofte voor het ophalen van een instelling op de opgegeven sleutel en het opgegeven bereik |
| query |
Retourneert een belofte voor het uitvoeren van query's op een set verzamelingen |
| query |
Retourneert een belofte voor het uitvoeren van query's op een set verzamelingen |
| set |
Retourneert een belofte voor het instellen van een document in de opgegeven verzameling Maakt het document als het niet bestaat, anders wordt het bestaande document bijgewerkt met de opgegeven id |
| set |
Retourneert een belofte voor het opslaan van een instelling op de opgegeven sleutel en het opgegeven bereik |
| update |
Retourneert een belofte voor het bijwerken van een document in de opgegeven verzameling Een document met de opgegeven id moet bestaan |
Methodedetails
createDocument(string, any, IDocumentOptions)
Retourneert een belofte voor het maken van een document in de opgegeven verzameling
function createDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>Parameters
- collectionName
-
string
De naam van de collectie waar het document zich bevindt
- doc
-
any
Het document om op te slaan
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<any>
deleteDocument(string, string, IDocumentOptions)
Retourneert een belofte voor het verwijderen van het document binnen het opgegeven bereik, verzameling en id
function deleteDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<void>Parameters
- collectionName
-
string
De naam van de collectie waar het document zich bevindt
- id
-
string
De id van het document in de collectie
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<void>
getDocument(string, string, IDocumentOptions)
Retourneert een belofte voor het verkrijgen van een document met de opgegeven id in de opgegeven verzameling
function getDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<any>Parameters
- collectionName
-
string
De naam van de collectie waar het document zich bevindt
- id
-
string
De id van het document in de collectie
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<any>
getDocuments(string, IDocumentOptions)
Retourneert een belofte voor het verkrijgen van alle documenten in de meegeleverde collectie
function getDocuments(collectionName: string, documentOptions?: IDocumentOptions): Promise<any[]>Parameters
- collectionName
-
string
De naam van de collectie waar het document zich bevindt
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<any[]>
getValue<T>(string, IDocumentOptions)
Retourneert een belofte voor het ophalen van een instelling op de opgegeven sleutel en het opgegeven bereik
function getValue<T>(key: string, documentOptions?: IDocumentOptions): Promise<T>Parameters
- key
-
string
De sleutel om een waarde op te halen voor
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<T>
queryCollections(ExtensionDataCollection[])
Retourneert een belofte voor het uitvoeren van query's op een set verzamelingen
function queryCollections(collections: ExtensionDataCollection[]): Promise<ExtensionDataCollection[]>Parameters
- collections
De lijst met collecties die u moet opvragen. Elke verzameling bevat de volgende collectionName, scopeType en scopeValue
Retouren
Promise<ExtensionDataCollection[]>
queryCollectionsByName(string[])
Retourneert een belofte voor het uitvoeren van query's op een set verzamelingen
function queryCollectionsByName(collectionNames: string[]): Promise<ExtensionDataCollection[]>Parameters
- collectionNames
-
string[]
Retouren
Promise<ExtensionDataCollection[]>
setDocument(string, any, IDocumentOptions)
Retourneert een belofte voor het instellen van een document in de opgegeven verzameling Maakt het document als het niet bestaat, anders wordt het bestaande document bijgewerkt met de opgegeven id
function setDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>Parameters
- collectionName
-
string
De naam van de collectie waar het document zich bevindt
- doc
-
any
Het document om op te slaan
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<any>
setValue<T>(string, T, IDocumentOptions)
Retourneert een belofte voor het opslaan van een instelling op de opgegeven sleutel en het opgegeven bereik
function setValue<T>(key: string, value: T, documentOptions?: IDocumentOptions): Promise<T>Parameters
- key
-
string
De sleutel om een waarde voor te bewaren
- value
-
T
De waarde om te besparen
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<T>
updateDocument(string, any, IDocumentOptions)
Retourneert een belofte voor het bijwerken van een document in de opgegeven verzameling Een document met de opgegeven id moet bestaan
function updateDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>Parameters
- collectionName
-
string
De naam van de collectie waar het document zich bevindt
- doc
-
any
Het document om op te slaan
- documentOptions
- IDocumentOptions
Opties voor uitbreidingsdocumenten, de standaardbereikwaarde is accountbreed
Retouren
Promise<any>