baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
86 lines (85 loc) • 3.5 kB
TypeScript
/**
* @module roleRoute
* @description Baasic Role Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Role 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 { IOptions } from '../../common/contracts';
import { IRole } from './contracts';
import { IAppOptions } from '../../core/contracts';
import { RoleBatchRoute } from './';
export declare class RoleRoute extends BaseRoute {
protected appOptions: IAppOptions;
protected roleBatchRoute: RoleBatchRoute;
/**
* Find route with route and query parameters.
**/
findRoute: string;
/**
* Get route with route and query parameters.
**/
getRoute: string;
/**
* Create route with route and query parameters.
**/
createRoute: string;
/**
* Update route with route and query parameters.
**/
updateRoute: string;
/**
* Remove route with route and query parameters.
**/
removeRoute: string;
/**
* Provides direct access to 'roleBatchRoute'
* @method
**/
readonly batch: RoleBatchRoute;
constructor(appOptions: IAppOptions, roleBatchRoute: RoleBatchRoute);
/**
* Parses find role route which can be expanded with additional options. Supported items are:
* - `searchQuery` - A string value used to identify role resources using the phrase search.
* - `page` - A value used to set the page number, i.e. to retrieve certain role subset from the storage.
* - `rpp` - A value used to limit the size of result set per page.
* - `sort` - A string used to set the role property to sort the result collection by.
* @method
* @param options Query resource options object.
* @example roleRoute.find({searchQuery: '<search-phrase>'});
**/
find(options: IOptions): any;
/**
* Parses get role route which should be expanded with the role Id. Note that the role Id is the primary key of the role.
* @method
* @param id Role unique indentifer.
* @param options Query resource options object.
* @example roleRoute.get().expand({id: '<role-id>'});
**/
get(id: string, options?: IOptions): any;
/**
* Parses create role route; this URI template does not expose any additional options.
* @method
* @example roleRoute.create();
**/
create(): any;
/**
* Parses update role route.
* @method
* @param data A role object used to update specified role resource.
* @example roleRoute.update(data);
*/
update(data: IRole): any;
/**
* Parses delete role route.
* @method
* @param data A role object used to delete specified role resource.
* @example roleRoute.delete(data);
*/
delete(data: IRole): any;
}
/**
* @overview
***Notes:**
- Refer to the [Baasic REST API](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 definition.
*/