Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArticleInstanceCommentRepliesRoute

Hierarchy

  • BaseRoute
    • ArticleInstanceCommentRepliesRoute

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected appOptions

appOptions: IAppOptions

approveRoute

approveRoute: string = "articles/{articleId}/comments/{commentId}/replies/{id}/approve"

createRoute

createRoute: string = "articles/{articleId}/comments/{commentId}/replies"

deleteAllRoute

deleteAllRoute: string = "articles/{articleId}/comments"

deleteRoute

deleteRoute: string = "articles/{articleId}/comments/{id}"

findRoute

findRoute: string = "articles/{articleId}/comments/{commentId}/replies/{?searchQuery,statuses,page,rpp,sort,embed,fields}"

flagRoute

flagRoute: string = "articles/{articleId}/comments/{commentId}/replies/{id}/flag"

getRoute

getRoute: string = "articles/{articleId}/comments/{commentId}/replies/{id}/{?embed,fields}"

Protected modelMapper

modelMapper: ModelMapper

reportRoute

reportRoute: string = "articles/{articleId}/comments/{commentId}/replies/{id}/report"

spamRoute

spamRoute: string = "articles/{articleId}/comments/{commentId}/replies/{id}/spam"

unapproveRoute

unapproveRoute: string = "/articles/{articleId}/comments/{commentId}/replies/{id}/unapprove"

unflagRoute

unflagRoute: string = "articles/{articleId}/comments/{commentId}/replies/{id}/unflag"

unreportRoute

unreportRoute: string = "articles/{articleId}/comments/{commentId}/replies/{id}/unreport"

unspamRoute

unspamRoute: string = "/articles/{articleId}/comments/{commentId}/replies/{id}/unspam"

updateRoute

updateRoute: string = "articles/{articleId}/comments/{id}"

Protected utility

utility: Utility

Methods

approve

  • Parameters

    Returns any

Protected baseCreate

  • baseCreate(route: string, data?: any): any

  • Parses get resource route which must be expanded with the Id of the previously created resource in the system.

    method
    example

    baseRoute.create();

    Parameters

    • route: string
    • Optional data: any

    Returns any

    get resource uri

Protected baseDelete

  • baseDelete(route: string, data: any, options?: IOptions, linkName?: string): any

  • Parses delete resource route.

    method
    example

    baseRoute.delete();

    Parameters

    • route: string
    • data: any
    • Optional options: IOptions
    • Optional linkName: string

    Returns any

    delete resource uri.

Protected baseFind

  • baseFind(route: string, options?: IOptions): any

  • Parses resources route which can be expanded with additional options. Supported items are:

    • searchQuery - A string value used to identify resources using the phrase search.
    • page - A value used to set the page number, i.e. to retrieve certain resource subset from the storage.
    • rpp - A value used to limit the size of result set per page.
    • sort - A string used to set the resource property to sort the result collection by.
    • embed - Comma separated list of resources to be contained within the current representation.
    method
    example

    baasicBaseDefinition.find();

    Parameters

    • route: string
    • Optional options: IOptions

    Returns any

    Query resources uri with search params

Protected baseGet

  • baseGet(route: string, id?: any, options?: any, propName?: string): any

  • Parses get resource route which must be expanded with the Id of the previously created resource in the system.

    method
    example

    baseRoute.get(route, id);

    Parameters

    • route: string
    • Optional id: any
    • Optional options: any
    • Optional propName: string

    Returns any

    get resource uri

Protected baseUpdate

  • baseUpdate(route: string, data: any, options?: IOptions, linkName?: string): any

  • Parses get resource route.

    method
    example

    baseRoute.update();

    Parameters

    • route: string
    • data: any
    • Optional options: IOptions
    • Optional linkName: string

    Returns any

    update resource uri

create

  • Parses create article comment reply route; this URI template does not support any additional items.

    method
    example

    articleCommentRepliesRoute.create(data);

    Parameters

    Returns any

createParams

  • createParams(data: any, prop?: string): any

  • Parameters

    • data: any
    • Optional prop: string

    Returns any

delete

  • Parameters

    Returns any

deleteAll

  • Parameters

    Returns any

deleteParams

  • deleteParams(data: any): any

  • Parameters

    • data: any

    Returns any

find

  • find(articleId: string, commentId: string, options?: IOptions): any

  • Parses find route which can be expanded with additional options. Supported items are:

    • searchQuery - A string value used to identify article comment reply resources using the phrase search.
    • page - A value used to set the page number, i.e. to retrieve certain article comment reply subset from the storage.
    • rpp - A value used to limit the size of result set per page.
    • sort - A string used to set the article comment reply property to sort the result collection by.
    • embed - Comma separated list of resources to be contained within the current representation.
    • statuses - Comma separated list of article comment reply states that specify where search should be done (Allowed states: Approved, Spam, Reported, Flagged and UnApproved).
    method
    example

    articleCommentRepliesRoute.find({ searchQuery: '' });

    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 any

flag

  • Parameters

    Returns any

get

  • get(articleId: string, commentId: string, replyId: string, options?: IGetRequestOptions): any

  • Parses get route which can be expanded with additional options. Supported items are:

    • id - Id which uniquely identifies article comment reply resource that needs to be retrieved.
    • embed - Comma separated list of resources to be contained within the current representation.
    method
    example

    articleCommentRepliesRoute.get({ id: '' });

    Parameters

    • articleId: string
    • commentId: string
    • replyId: string
    • Optional options: IGetRequestOptions

    Returns any

parse

  • parse(route: string): any

  • Parses and expands URI templates based on RFC6570 specifications. For more information please visit the project GitHub page.

    method
    example

    baseRoute.parse('/{?embed,fields,options}').expand({embed: ''});

    Parameters

    • route: string

    Returns any

report

  • Parameters

    Returns any

spam

  • Parameters

    Returns any

unapprove

  • Parameters

    Returns any

unflag

  • Parameters

    Returns any

unreport

  • Parameters

    Returns any

unspam

  • Parameters

    Returns any

update

  • Parameters

    Returns any

updateParams

  • updateParams(data: any): any

  • Parameters

    • data: any

    Returns any

Generated using TypeDoc