UNPKG

baasic-sdk-javascript

Version:

JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).

39 lines (38 loc) 1.82 kB
/** * @module mediaGalleryFileBatchRoute * @description Baasic Media Gallery Batch Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Media Gallery Batch Route Definition 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 MediaGalleryFileBatchRoute extends BaseRoute { protected appOptions: IAppOptions; readonly updateRoute: string; readonly unlinkRoute: string; readonly linkRoute: string; constructor(appOptions: IAppOptions); /** * Parses update route; this URI template does not expose any additional options. * @method * @example mediaGalleryFileBatchRoute.update(); **/ update(): any; /** * Parses link route; this URI template does not expose any additional options. * @method * @example mediaGalleryFileBatchRoute.link(); **/ link(): any; /** * Parses unlink route; this URI template does not expose any additional options. * @method * @example mediaGalleryFileBatchRoute.unlink(); **/ unlink(): any; } /** * @overview ***Notes:** - Refer to the [REST API documentation](http://dev.baasic.com/api/reference/home) 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. */