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.44 kB
TypeScript
/**
* @module mediaGalleryInstanceFilesBatchRoute
* @description Baasic Media Gallery Instance Files Batch Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Media Gallery 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 MediaGalleryInstanceFilesBatchRoute 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 mediaGalleryId Media Gallery file id of the original media gallery file used to identify media gallery files on which delete action should be performed.
* @example mediaGalleryInstanceFilesBatchRoute.unlink(mediaGalleryId);
**/
unlink(mediaGalleryId: string): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @param mediaGalleryId Media Gallery id which uniquely identifies media gallery whose media gallery file need to be updated.
* @example mediaGalleryInstanceFilesStreamsRoute.update(mediaGalleryId);
**/
update(mediaGalleryId: string): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @param mediaGalleryId Media Gallery slug or id which uniquely identifies media gallery whose media gallery files need to be linked.
* @example mediaGalleryInstanceFilesStreamsRoute.link(mediaGalleryId);
**/
link(mediaGalleryId: 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.
*/