Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ArticleSubscriptionsArticleClient

Index

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected articleSubscriptionsArticleRoute

articleSubscriptionsArticleRoute: ArticleSubscriptionsArticleRoute

Accessors

routeDefinition

Methods

isSubscribed

  • 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
    example

    articleSubscriptionsArticleClient.subscribe(article, user) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    Returns PromiseLike<IHttpResponse<any>>

    A promise that is resolved once the isSubscribed action has been performed.

subscribe

  • Returns a promise that is resolved once the subscribe action has been performed. This action subscribes an user to the specified article.

    method
    example

    articleSubscriptionsArticleClient.subscribe(article, user) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    Returns PromiseLike<IHttpResponse<any>>

    A promise that is resolved once the subscribe action has been performed.

unSubscribe

  • Returns a promise that is resolved once the unSubscribe action has been performed. This action unsubscribes a user from the specified article.

    method
    example

    articleSubscriptionsArticleClient.subscribe(article, user) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    Returns PromiseLike<IHttpResponse<void>>

    A promise that is resolved once the unSubscribe action has been performed.

Generated using TypeDoc