baasic-sdk-angularjs
Version:
AngularJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
73 lines (46 loc) • 2.05 kB
Markdown
# baasicArticleSettingsService
Baasic Article Settings Service provides an easy way to consume Baasic Article Settings REST API end-points. In order to obtain needed routes `baasicArticleSettingsService` uses `baasicArticleSettingsRouteService`.
* * *
### baasicArticleSettingsService.get()
Returns a promise that is resolved once the get action has been performed. Success response returns the article settings.
**Example**:
```js
baasicArticleSettingsService.get()
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicArticleSettingsService.update()
Returns a promise that is resolved once the update article settings action has been performed; this action updates article settings. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicArticleSettingsRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(articleSettings);
var uri = params['model'].links('put').href;
```
**Example**:
```js
// articleSettings is a resource previously fetched using get action.
articleSettings.allowArchive = true;
baasicArticleSettingsService.update(articleSettings)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicArticleSettingsService.routeService()
Provides direct access to `baasicArticleSettingsRouteService`.
**Example**:
```js
baasicArticleSettingsService.routeService.get(expandObject);
```
* * *
**Notes:**
- Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- All end-point objects are transformed by the associated route service.
*(c) 2017 Mono Ltd*
**Author:** Mono Ltd
**License:** MIT