baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
59 lines (58 loc) • 3.29 kB
TypeScript
/**
* @module articleSubscriptionsArticleClient
* @description Article Subscriptions Article Client provides an easy way to consume Articles REST API end-points. In order to obtain needed routes `articleSubscriptionsArticleClient` uses `articleSubscriptionsArticleRoute`.
*/
import { ApiClient, IHttpResponse } from '../../../httpApi';
import { ArticleSubscriptionsArticleRoute } from '../';
import { IArticle, IArticleSubscription } from '../contracts';
export declare class ArticleSubscriptionsArticleClient {
protected articleSubscriptionsArticleRoute: ArticleSubscriptionsArticleRoute;
protected apiClient: ApiClient;
readonly routeDefinition: ArticleSubscriptionsArticleRoute;
constructor(articleSubscriptionsArticleRoute: ArticleSubscriptionsArticleRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the subscribe action has been performed. This action subscribes an user to the specified article.
* @method
* @param article The article identifier.
* @param data The subscribe information.
* @returns A promise that is resolved once the subscribe action has been performed.
* @example articleSubscriptionsArticleClient.subscribe(article, user)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
subscribe(article: IArticle, data: IArticleSubscription): PromiseLike<IHttpResponse<any>>;
/**
* Returns a promise that is resolved once the isSubscribed action has been performed. This action checks if a user is subscribed to the specified article.
* @method
* @param article The article identifier.
* @param data The subscriber identifier.
* @returns A promise that is resolved once the isSubscribed action has been performed.
* @example articleSubscriptionsArticleClient.subscribe(article, user)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
isSubscribed(article: IArticle, data: IArticleSubscription): PromiseLike<IHttpResponse<any>>;
/**
* Returns a promise that is resolved once the unSubscribe action has been performed. This action unsubscribes a user from the specified article.
* @method
* @param article The article identifier.
* @param data The unsubscribe information.
* @returns A promise that is resolved once the unSubscribe action has been performed.
* @example articleSubscriptionsArticleClient.subscribe(article, user)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
unSubscribe(article: IArticle, data: IArticleSubscription): PromiseLike<IHttpResponse<void>>;
}