Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArticleInstanceCommentsRoute

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected appOptions

appOptions: IAppOptions

approveRoute

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

Protected articleInstanceCommentRepliesRoute

articleInstanceCommentRepliesRoute: ArticleInstanceCommentRepliesRoute

createRoute

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

deleteAllRoute

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

deleteRoute

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

findRoute

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

flagRoute

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

getRoute

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

Protected modelMapper

modelMapper: ModelMapper

reportRoute

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

spamRoute

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

unapproveRoute

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

unflagRoute

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

unreportRoute

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

unspamRoute

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

updateRoute

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

Protected utility

utility: Utility

Accessors

replies

Methods

approve

  • Parses approve route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.approve(data);

    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 route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.create(data);

    Parameters

    • data: IArticleComment

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

    Returns any

createParams

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

  • Parameters

    • data: any
    • Optional prop: string

    Returns any

delete

  • Parses delete route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.delete(data);

    Parameters

    • data: IArticleComment

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

    Returns any

deleteAll

  • Parses delete all route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.deleteAll(data);

    Parameters

    • data: IArticle

      An article object used to delete specified article comment resource.

    Returns any

deleteParams

  • deleteParams(data: any): any

  • Parameters

    • data: any

    Returns any

find

  • find(articleId: 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 resources using the phrase search.
    • page - A value used to set the page number, i.e. to retrieve certain article comment 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 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 states that specify where search should be done (Allowed states: Approved, Spam, Reported, Flagged and UnApproved).
    method
    example

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

    Parameters

    • articleId: string

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

    • Optional options: IOptions

      Query resource options object.

    Returns any

flag

  • Parses flag route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.flag(data);

    Parameters

    Returns any

get

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

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

    articleInstanceCommentsRoute.get().expand({ id: '' });

    Parameters

    • articleId: string

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

    • Optional commentId: string

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

    • Optional options: IGetRequestOptions

      Options object that contains embed data.

    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

  • Parses report route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.report(data);

    Parameters

    Returns any

spam

  • Parses spam route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.spam(data);

    Parameters

    Returns any

unapprove

  • Parses unapprove route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.unapprove(data);

    Parameters

    Returns any

unflag

  • Parses unflag route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.unflag(data);

    Parameters

    Returns any

unreport

  • Parses unreport route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.unreport(data);

    Parameters

    Returns any

unspam

  • Parses unspam route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.unspam(data);

    Parameters

    Returns any

update

  • Parses update route; this URI template doesnt support any additional options.

    method
    example

    articleInstanceCommentsRoute.update(data);

    Parameters

    • data: IArticleComment

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

    Returns any

updateParams

  • updateParams(data: any): any

  • Parameters

    • data: any

    Returns any

Generated using TypeDoc