baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
36 lines (35 loc) • 1.76 kB
TypeScript
/**
* @module ArticleSubscriptionsRoute
* @description Baasic Article Subscriptions Article Module Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Article Subscriptions Article Module 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';
import { IArticleSubscription } from './contracts';
export declare class ArticleSubscriptionsRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly subscribeRoute: string;
readonly isSubscribedRoute: string;
readonly unSubscribeRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses article module subscribe route which doesn't support any additional options.
* @method
* @param data The subscribe information.
* @example articleSubscriptionsRoute.subscribe(data);
**/
subscribe(data: IArticleSubscription): any;
/**
* Parses article module isSubscribed route which must be expanded with subscriber Id
* @method
* @param data The subscribe information.
* @example articleSubscriptionsRoute.isSubscribed({subscriberId: '<subscriber-id>'});
**/
isSubscribed(data: IArticleSubscription): any;
/**
* Parses article module unSubscribe route which doesn't support any additional options.
* @method
* @param data The subscribe information.
* @example articleSubscriptionsRoute.unSubscribe(data);
**/
unSubscribe(data: IArticleSubscription): any;
}