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.49 kB
TypeScript
/**
* @module filesRoute
* @description Baasic Files Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Files 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 { IGetRequestOptions, IOptions } from '../../common/contracts';
import { FilesStreamsRoute } from './';
import { IFileEntry } from './contracts';
import { IAppOptions } from '../../core/contracts';
export declare class FilesRoute extends BaseRoute {
protected appOptions: IAppOptions;
protected filesStreamsRoute: FilesStreamsRoute;
readonly findRoute: string;
readonly getRoute: string;
readonly updateRoute: string;
readonly unlinkRoute: string;
readonly linkRoute: string;
readonly streams: FilesStreamsRoute;
constructor(appOptions: IAppOptions, filesStreamsRoute: FilesStreamsRoute);
/**
* 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 filesRoute.find({searchQuery: '<search-phrase>'});
**/
find(options?: IOptions): any;
/**
* Parses get route; this route should be expanded with the Id of the file resource.
* @method
* @param id File id which uniquely identifies file resource that needs to be retrieved.
* @param options Query resource options object.
* @example filesRoute.get({id: '<file-id>'});
**/
get(id: string, options?: IGetRequestOptions): any;
/**
* Parses update route; this route should be expanded with the Id of the file resource.
* @method
* @param data A file entry object used to update specific file entry resource in the system.
* @example filesRoute.get({id: '<file-id>'});
**/
update(data: IFileEntry): any;
/**
* Parses unlink route; this route should be expanded with the Id of the file resource.
* @method
* @param data A file entry object used to update specific file entry resource in the system.
* @example filesRoute.unlink({id: '<file-id>'});
**/
unlink(data: IFileEntry, options?: Object): any;
/**
* Parses link route; this URI template does not expose any additional options.
* @method
* @example filesRoute.link();
**/
link(): 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.
*/