baasic-sdk-angularjs
Version:
AngularJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
117 lines (116 loc) • 4.82 kB
JavaScript
/* globals module */
/**
* @module baasicUserSkillService
* @description Baasic User Skill Service provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic User Skill Route Service to obtain needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.
*/
(function (angular, module, undefined) {
'use strict';
module.service('baasicUserSkillService', ['baasicApp',
function (baasicApps) {
var baasicApp = baasicApps.get();
return {
/**
* Returns a promise that is resolved once the create user skill action has been performed; this action creates a new user skill resource.
* @method
* @example
baasicUserSkillService.create({
skillName : '<skill-name>',
userId: '<user-id>'
})
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
**/
create: function (data) {
return baasicApp.userProfileModule.profile.skill.create(data);
},
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of user skill resources matching the given criteria.
* @method
* @example
baasicUserSkillService.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>'
})
.success(function (collection) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
**/
find: function (options) {
return baasicApp.userProfileModule.profile.skill.find(options);
},
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the user skill resource.
* @method
* @example
baasicUserSkillService.get()
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
**/
get: function (id, options) {
return baasicApp.userProfileModule.profile.skill.get(id, options);
},
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove a user skill resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicUserSkillRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(skill);
var uri = params['model'].links('delete').href;
```
* @method
* @example
// skill is a resource previously fetched using get action.
baasicUserSkillService.remove(skill)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
**/
remove: function (data) {
return baasicApp.userProfileModule.profile.skill.remove(data);
},
/**
* Returns a promise that is resolved once the update user skill action has been performed; this action updates a user skill resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicUserSkillRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(skill);
var uri = params['model'].links('put').href;
```
* @method
* @example
// skill is a resource previously fetched using get action.
skill.description = '<description>';
baasicUserSkillService.update(skill)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
**/
update: function (data) {
return baasicApp.userProfileModule.profile.skill.update(data);
}
};
}
]);
}(angular, module));
/**
* @overview
***Notes:**
- Refer to the [REST API documentation](https://github.com/Baasic/baasic-rest-api/wiki) for detailed information about available Baasic REST API end-points.
- All end-point objects are transformed by the associated route service.
*/