baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
42 lines (41 loc) • 2.31 kB
TypeScript
/**
* @module articleInstanceFilesBatchRoute
* @description Baasic Article Instance Files Batch Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Article Files Batch 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.
*/
import { BaseRoute } from '../../../common';
import { IAppOptions } from '../../../core/contracts';
export declare class ArticleInstanceFilesBatchRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly unlinkRoute: string;
readonly updateRoute: string;
readonly linkRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses unlink route; this URI template does not expose any additional options.
* @method
* @param articleId Article file id of the original article file used to identify article files on which delete action should be performed.
* @example articleInstanceFilesBatchRoute.unlink(articleId);
**/
unlink(articleId: string): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @param articleId Article slug or id which uniquely identifies article whose article file need to be updated.
* @example articleInstanceFilesStreamsRoute.update(articleId);
**/
update(articleId: string): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @param articleId Article slug or id which uniquely identifies article whose article files need to be linked.
* @example articleInstanceFilesStreamsRoute.link(articleId);
**/
link(articleId: string): any;
}
/**
* @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.
- [URI Template](https://github.com/Baasic/uritemplate-js) syntax enables expanding the Baasic route templates to Baasic REST URIs providing it with an object that contains URI parameters.
- All end-point objects are transformed by the associated route service.
*/