baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
44 lines (43 loc) • 2.26 kB
TypeScript
/**
* @module mediaVaultStreamsRoute
* @description Baasic MediaVault Streams Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Media Vault Streams 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 MediaVaultStreamsRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly getRoute: string;
readonly createRoute: string;
readonly updateRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses get route; this route should be expanded with id or path of desired media vault stream. Additional supported items are:
* - `width` - width of desired derived image.
* - `height` - height of desired derived image.
* - `t` - cache invalidation param.
* @method
* @example mediaVaultRoute.get({id: '<path>'});
**/
get(data: any): any;
/**
* Parses create route; this route should be expanded with the path which indicates where the stream will be saved.
* @method
* @example mediaVaultStreamsRoute.create({path: '<path>'});
**/
create(data: any): any;
/**
* Parses update route; this route should be expanded with the id or path of the previously saved media vault resource. Additional supported items are:
* - `width` - width of desired derived image.
* - `height` - height of desired derived image.
* @method
* @example mediaVaultStreamsRoute.update({id: '<path>'});
**/
update(data: any): 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.
*/