ContentProviderAPI.js 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. "use strict";
  2. function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
  3. /**
  4. * Licensed Materials - Property of IBM
  5. * IBM Business Analytics (C) Copyright IBM Corp. 2020
  6. * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  7. */
  8. /**
  9. * @class ContentProviderAPI
  10. * @hideconstructor
  11. * @classdesc API class that is used to generate content specs and create them
  12. */
  13. define([], function () {
  14. var ContentProviderAPI = function () {
  15. function ContentProviderAPI() {
  16. _classCallCheck(this, ContentProviderAPI);
  17. }
  18. /**
  19. * @public
  20. * @function ContentProviderAPI#addModel
  21. * @description Adds a new model to the boardModel
  22. * @param {Object} content
  23. * @param {String} content.type Content provider type to use.
  24. * @param {Object} content.properties An object of property names & values to apply to the content.
  25. * @param {TransactionToken} transactionToken
  26. * @returns {Promise} Promise resolved with the added model id
  27. */
  28. ContentProviderAPI.prototype.addModel = function addModel() {};
  29. /**
  30. * @public
  31. * @function ContentProviderAPI#createContent
  32. * @description Creates a content object
  33. * @param {Object} options Parameters to pass to the content class for instantiation
  34. * @returns {Content} The content object
  35. */
  36. ContentProviderAPI.prototype.createContent = function createContent() {};
  37. /**
  38. * @public
  39. * @function ContentProviderAPI#getTypeList
  40. * @description Get the list of supported content types
  41. * @returns {Array} A list of the supported content types
  42. */
  43. ContentProviderAPI.prototype.getTypeList = function getTypeList() {};
  44. return ContentProviderAPI;
  45. }();
  46. return ContentProviderAPI;
  47. });
  48. //# sourceMappingURL=ContentProviderAPI.js.map