baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
43 lines (42 loc) • 2.4 kB
TypeScript
/**
* @module userSocialLoginRoute
* @description Baasic User Social Login Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic User 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 UserSocialLoginRoute extends BaseRoute {
protected appOptions: IAppOptions;
/**
* Get route with route and query parameters.
**/
getRoute: string;
/**
* Remove route with route and query parameters.
**/
removeRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses get social login route, URI template should be expanded with the username of the user resource whose social login connections should be retrieved.
* @method
* @param username A username or id which uniquely identifies user resource whose social login connections need to be retrieved.
* @example userSocialLoginRoute.get('<username>');
**/
get(username: string): any;
/**
* Parses remove social login route which can be expanded with additional items. Supported items are:
* - `username` - A username which uniquely identifies an application user whose social login connection needs to be removed.
* - `provider` - Provider from which to disconnect the login resource from.
* @method
* @param username A username which uniquely identifies an application user whose social login connection needs to be removed.
* @param provider Provider from which to disconnect the login resource from.
* @example userSocialLoginRoute.remove('<username>', '<provider>');
**/
remove(username: string, provider: any): 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.
*/