baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
56 lines (55 loc) • 3.19 kB
TypeScript
/**
* @module articleSubscriptionsCommentReportedClient
* @description Article Subscriptions Comment Reported Client provides an easy way to consume Articles REST API end-points. In order to obtain needed routes `articleSubscriptionsCommentReportedClient` uses `articleSubscriptionsCommentReportedRoute`.
*/
import { ApiClient, IHttpResponse } from '../../../httpApi';
import { ArticleSubscriptionsCommentReportedRoute } from '../';
import { IArticleSubscription } from '../contracts';
export declare class ArticleSubscriptionsCommentReportedClient {
protected articleSubscriptionsCommentReportedRoute: ArticleSubscriptionsCommentReportedRoute;
protected apiClient: ApiClient;
readonly routeDefinition: ArticleSubscriptionsCommentReportedRoute;
constructor(articleSubscriptionsCommentReportedRoute: ArticleSubscriptionsCommentReportedRoute, apiClient: ApiClient);
/**
* Subscribes user to article comment reported updates. Returns a promise that is resolved once the subscribe action has been performed.
* @method
* @param data The subscribe information.
* @returns A promise that is resolved once the subscribe action has been performed.
* @example articleSubscriptionsCommentReportedClient.subscribe(data)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
subscribe(data: IArticleSubscription): PromiseLike<IHttpResponse<any>>;
/**
* Determines whether user is subscribed to article comment reported updates. Returns a promise that is resolved once the isSubscribed action has been performed.
* @method
* @param data The subscribe information.
* @returns A promise that is resolved once the isSubscribed action has been performed.
* @example articleSubscriptionsCommentReportedClient.isSubscribed(data)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
isSubscribed(data: IArticleSubscription): PromiseLike<IHttpResponse<any>>;
/**
* Unsubscribe user from article comment reported updates. Returns a promise that is commentReported once the unSubscribe action has been performed.
* @method
* @param data The unsubscribe information.
* @returns A promise that is commentReported once the unSubscribe action has been performed.
* @example articleSubscriptionsCommentReportedClient.isSubscribed(data)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
unSubscribe(data: IArticleSubscription): PromiseLike<IHttpResponse<void>>;
}