Created ngDocs for modelsBuilderManagementResource
This commit is contained in:
committed by
Nathan Woulfe
parent
7e15c6fd78
commit
37aa00dc4a
@@ -1,18 +1,82 @@
|
||||
|
||||
/**
|
||||
* @ngdoc service
|
||||
* @name umbraco.resources.modelsBuilderManagementResource
|
||||
* @description Resources to get information on modelsbuilder status and build models
|
||||
**/
|
||||
function modelsBuilderManagementResource($q, $http, umbRequestHelper) {
|
||||
|
||||
return {
|
||||
|
||||
/**
|
||||
* @ngdoc method
|
||||
* @name umbraco.resources.modelsBuilderManagementResource#getModelsOutOfDateStatus
|
||||
* @methodOf umbraco.resources.modelsBuilderManagementResource
|
||||
*
|
||||
* @description
|
||||
* Gets the status of modelsbuilder
|
||||
*
|
||||
* ##usage
|
||||
* <pre>
|
||||
* modelsBuilderManagementResource.getModelsOutOfDateStatus()
|
||||
* .then(function() {
|
||||
* Do stuff...*
|
||||
* });
|
||||
* </pre>
|
||||
*
|
||||
* @returns {Promise} resourcePromise object.
|
||||
*
|
||||
*/
|
||||
getModelsOutOfDateStatus: function () {
|
||||
return umbRequestHelper.resourcePromise(
|
||||
$http.get(umbRequestHelper.getApiUrl("modelsBuilderBaseUrl", "GetModelsOutOfDateStatus")),
|
||||
"Failed to get models out-of-date status");
|
||||
},
|
||||
|
||||
/**
|
||||
* @ngdoc method
|
||||
* @name umbraco.resources.modelsBuilderManagementResource#buildModels
|
||||
* @methodOf umbraco.resources.modelsBuilderManagementResource
|
||||
*
|
||||
* @description
|
||||
* Builds the models
|
||||
*
|
||||
* ##usage
|
||||
* <pre>
|
||||
* modelsBuilderManagementResource.buildModels()
|
||||
* .then(function() {
|
||||
* Do stuff...*
|
||||
* });
|
||||
* </pre>
|
||||
*
|
||||
* @returns {Promise} resourcePromise object.
|
||||
*
|
||||
*/
|
||||
buildModels: function () {
|
||||
return umbRequestHelper.resourcePromise(
|
||||
$http.post(umbRequestHelper.getApiUrl("modelsBuilderBaseUrl", "BuildModels")),
|
||||
"Failed to build models");
|
||||
},
|
||||
|
||||
/**
|
||||
* @ngdoc method
|
||||
* @name umbraco.resources.modelsBuilderManagementResource#getDashboard
|
||||
* @methodOf umbraco.resources.modelsBuilderManagementResource
|
||||
*
|
||||
* @description
|
||||
* Gets the modelsbuilder dashboard
|
||||
*
|
||||
* ##usage
|
||||
* <pre>
|
||||
* modelsBuilderManagementResource.getDashboard()
|
||||
* .then(function() {
|
||||
* Do stuff...*
|
||||
* });
|
||||
* </pre>
|
||||
*
|
||||
* @returns {Promise} resourcePromise object.
|
||||
*
|
||||
*/
|
||||
getDashboard: function () {
|
||||
return umbRequestHelper.resourcePromise(
|
||||
$http.get(umbRequestHelper.getApiUrl("modelsBuilderBaseUrl", "GetDashboard")),
|
||||
|
||||
Reference in New Issue
Block a user