baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
68 lines (67 loc) • 3.61 kB
TypeScript
/**
* @module blogPostFilesRoute
* @description Baasic Blog Post Files Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Article Files 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 { IGetRequestOptions } from '../../common/contracts';
import { IAppOptions } from '../../core/contracts';
import { BlogPostFilesBatchRoute, BlogPostFilesStreamsRoute } from './';
import { IBlogPostFile, IBlogPostFileOptions } from './contracts';
export declare class BlogPostFilesRoute extends BaseRoute {
protected blogPostFilesStreamsRoute: BlogPostFilesStreamsRoute;
protected blogPostFilesBatchRoute: BlogPostFilesBatchRoute;
protected appOptions: IAppOptions;
readonly findRoute: string;
readonly getRoute: string;
readonly linkRoute: string;
readonly unlinkRoute: string;
readonly updateRoute: string;
readonly streams: BlogPostFilesStreamsRoute;
readonly batch: BlogPostFilesBatchRoute;
constructor(blogPostFilesStreamsRoute: BlogPostFilesStreamsRoute, blogPostFilesBatchRoute: BlogPostFilesBatchRoute, appOptions: IAppOptions);
/**
* Parses find route which can be expanded with additional options. Supported items are:
* - `searchQuery` - A string referencing file properties using the phrase search.
* - `page` - A value used to set the page number, i.e. to retrieve certain file subset from the storage.
* - `rpp` - A value used to limit the size of result set per page.
* - `sort` - A string used to set the file property to sort the result collection by.
* - `embed` - Comma separated list of resources to be contained within the current representation.
* @method
* @param options Query resource options object.
* @example blogPostFilesRoute.find({searchQuery: '<search-phrase>'});
**/
find(options?: IBlogPostFileOptions): any;
/**
* Parses get route; this route should be expanded with the Id of the file resource.
* @method
* @param id Article file id which uniquely identifies article resource that needs to be retrieved.
* @param options Options object that contains embed data.
* @example blogPostFilesRoute.get({id: '<file-id>'});
**/
get(id: string, options?: IGetRequestOptions): any;
/**
* Parses link route; this URI template does not expose any additional options.
* @method
* @example blogPostFilesRoute.link();
**/
link(): any;
/**
* Parses unlink route; this URI template does not expose any additional options.
* @method
* @example blogPostFilesRoute.unlink(data);
**/
unlink(data: IBlogPostFile, options: Object): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @example blogPostFilesRoute.update(data);
**/
update(data: any): 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.
*/