IExtensionDataService

Last Update: 9/26/2016

Defined in vss.d.ts

Service which allows for getting and setting of extension data

Members

  • getValue: (key: string, documentOptions: IDocumentOptions): IPromise<T>. Returns a promise for retrieving a setting at the provided key and scope

  • setValue: (key: string, value: T, documentOptions: IDocumentOptions): IPromise<T>. Returns a promise for saving a setting at the provided key and scope

  • getDocument: (collectionName: string, id: string, documentOptions: IDocumentOptions): IPromise<any>. Returns a promise for getting a document with the provided ID in the provided collection

  • getDocuments: (collectionName: string, documentOptions: IDocumentOptions): IPromise<any[]>. Returns a promise for getting all of the documents in the provided collection

  • createDocument: (collectionName: string, doc: any, documentOptions: IDocumentOptions): IPromise<any>. Returns a promise for creating a document in the provided collection

  • setDocument: (collectionName: string, doc: any, documentOptions: IDocumentOptions): IPromise<any>. Returns a promise for setting a document in the provided collection Creates the document if it does not exist, otherwise updates the existing document with the ID provided

  • updateDocument: (collectionName: string, doc: any, documentOptions: IDocumentOptions): IPromise<any>. Returns a promise for updating a document in the provided collection A document with the ID provided must exist

  • deleteDocument: (collectionName: string, id: string, documentOptions: IDocumentOptions): IPromise<void>. Returns a promise for deleting the document at the provided scope, collection and id