Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArticleInstanceCommentRepliesClient

Hierarchy

  • ArticleInstanceCommentRepliesClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected articleInstanceCommentRepliesRoute

articleInstanceCommentRepliesRoute: ArticleInstanceCommentRepliesRoute

statuses

statuses: ICommentStatus = CommentStatus

Contains a reference to valid list of article comment reply states. It returns an object containing all article comment reply states.

method
example

articleCommentRepliesClient.statuses.approved;

Accessors

routeDefinition

  • Provides direct access to articleCommentRepliesRoute.

    method
    example

    articleInstanceCommentRepliesClient.routeDefinition.get();

    Returns ArticleInstanceCommentRepliesRoute

Methods

approve

  • Returns a promise that is resolved once the approve article comment reply action has been performed. This action sets the state of an article comment reply to "approved". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-approve').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.approve(articleCommentReply, commentOptions) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IArticleCommentReply

      Article Comment Reply object.

    • options: IOptions

      Notification configuration used to control the article comment recourse access when managing notification distribution.

    Returns PromiseLike<IHttpResponse<void>>

create

  • Returns a promise that is resolved once the create article comment reply action has been performed; this action creates a new comment reply for an article.

    method
    example

    articleInstanceCommentRepliesClient.create('', { commentId : '', comment : , userId : '' }) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • articleId: string

      Article id which uniquely identifies article that needs to be updated with new comment reply resource.

    • data: IArticleCommentReply

      An article comment reply object that needs to be inserted into the system.

    Returns PromiseLike<IHttpResponse<IArticleCommentReply>>

    A promise that is resolved once the create article comment reply action has been performed.

find

  • Returns a promise that is resolved once the find action has been performed. Success response returns a list of article comment reply resources matching the given criteria.

    method
    example

    articleInstanceCommentRepliesClient.find({ pageNumber : 1, pageSize : 10, orderBy : '', orderDirection : '', search : '' }) .then(function (collection) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • articleId: string

      Article id which uniquely identifies article whose comment reply resources need to be retrieved.

    • commentId: string

      Comment id which uniquely identifies comment whose reply resources need to be retrieved.

    • Optional options: IOptions

      Query resource options.

    Returns PromiseLike<IHttpResponse<IQueryModel<IArticleCommentReply>>>

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

flag

  • Returns a promise that is resolved once the flag article comment reply action has been performed. This action sets the state of an article comment reply to "flagged". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-flag').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.flag(articleCommentReply) .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 flag article comment reply action has been performed.

get

  • Returns a promise that is resolved once the get action has been performed. Success response returns the specified article comment reply resource.

    method
    example

    articleInstanceCommentRepliesClient.get('') .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • articleId: string

      Article id which uniquely identifies article whose comment reply resource needs to be retrieved.

    • commentId: string

      Comment id which uniquely identifies comment whose reply resource needs to be retrieved.

    • replyId: string

      Id which uniquely identifies article comment reply resource that needs to be retrieved.

    • Optional options: IGetRequestOptions

      Options object that contains embed data.

    Returns PromiseLike<IHttpResponse<IArticleCommentReply>>

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

remove

  • Returns a promise that is resolved once the remove article comment reply action has been performed. If the action is successfully completed, the article comment reply resource will be permanently removed from the system. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = apiClient.removeParams(articleCommentReply);
let uri = params['model'].links('delete').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.remove(articleCommentReply) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IArticleCommentReply

      An article comment object used to delete specified article comment reply resource.

    Returns PromiseLike<IHttpResponse<void>>

    A promise that is resolved once the remove article comment reply action has been performed.

removeAll

  • Returns a promise that is resolved once the removeAll article comment reply action has been performed. This action will remove all comment replies from an article comment if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleInstanceCommentsRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.removeParams(articleCommentReply);
let uri = params['model'].links('delete-comments-by-article').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.removeAll(articleCommentReply) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IArticle

      Article object used to delete all article comments in the system.

    Returns PromiseLike<IHttpResponse<void>>

    a promise that is resolved once the removeAll article comment reply action has been performed.

report

  • Returns a promise that is resolved once the report article comment reply action has been performed. This action sets the state of an article comment reply to "reported". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-report').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.report(articleCommentReply, commentOptions) .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 report article comment reply action has been performed.

spam

  • Returns a promise that is resolved once the mark as spam article comment reply action has been performed. This action sets the state of an article comment reply to "spam". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-spam').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.spam(articleCommentReply) .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 mark as spam article comment reply action has been performed.

unapprove

  • Returns a promise that is resolved once the unapprove article comment reply action has been performed. This action sets the state of an article comment reply to "unapproved". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-unapprove').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.unapprove(articleCommentReply) .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 unapprove article comment reply action has been performed.

unflag

  • Returns a promise that is resolved once the unflag article comment reply action has been performed. This action removes the "flagged" comment reply state. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-unflag').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.unflag(articleCommentReply) .success(function (data) { // perform success action here }).error(function (response, status, headers, config) { // perform error handling here });

    Parameters

    Returns PromiseLike<IHttpResponse<void>>

    A promise that is resolved once the unflag article comment reply action has been performed.

unreport

  • Returns a promise that is resolved once the unreport article comment reply action has been performed. This action removes the "reported" comment reply state. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-unreport').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.unreport(articleCommentReply) .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 unreport article comment reply action has been performed.

unspam

  • Returns a promise that is resolved once the unspam article comment reply action has been performed. This action removes the "spam" comment reply state. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('comment-unspam').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.unspam(articleCommentReply) .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 unspam article comment reply action has been performed.

update

  • Returns a promise that is resolved once the update article comment reply action has been performed; this action updates an article comment reply resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply articleCommentRepliesRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(articleCommentReply);
let uri = params['model'].links('put').href;
    method
    example

    // articleCommentReply is a resource previously fetched using get action. articleInstanceCommentRepliesClient.update(articleCommentReply) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IArticleCommentReply

      An article comment object used to update specified article comment reply resource.

    Returns PromiseLike<IHttpResponse<void>>

    A promise that is resolved once the update article comment reply action has been performed.

Generated using TypeDoc