baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
38 lines (37 loc) • 1.86 kB
TypeScript
/**
* @module registerRoute
* @description Baasic Register Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Register 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 RegisterRoute extends BaseRoute {
protected appOptions: IAppOptions;
/**
* Create route with route and query parameters.
**/
createRoute: string;
/**
* Activate route with route and query parameters.
**/
activateRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses register route, this route doesn't support any additional properties.
* @method
* @example registerRoute.create();
**/
create(): any;
/**
* Parses activation route; route should be expanded with the `activationToken` which uniquely identifies the user account that needs to be activated.
* @method
* @param data Security code which uniquely identifies user account that needs to be activated.
* @example registerRoute.activate({activationToken: '<activation-token>'});
**/
activate(data: string): 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.
*/