Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArticleInstanceFilesRoute

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected appOptions

appOptions: IAppOptions

Protected articleInstanceFilesBatchRoute

articleInstanceFilesBatchRoute: ArticleInstanceFilesBatchRoute

Protected articleInstanceFilesStreamsRoute

articleInstanceFilesStreamsRoute: ArticleInstanceFilesStreamsRoute

findRoute

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

getRoute

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

linkRoute

linkRoute: string = "articles/{articleId}/files/link"

Protected modelMapper

modelMapper: ModelMapper

unlinkByArticleRoute

unlinkByArticleRoute: string = "articles/{articleId}/files/unlink/{id}"

unlinkRoute

unlinkRoute: string = "articles/{articleId}/files/unlink/{id}"

updateRoute

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

Protected utility

utility: Utility

Accessors

batch

streams

Methods

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

createParams

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

  • Parameters

    • data: any
    • Optional prop: string

    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 referencing file properties using the phrase search.
    • page - A value used to set the page number, i.e. to retrieve certain file subset from the storage.
    • rpp - A value used to limit the size of result set per page.
    • sort - A string used to set the file property to sort the result collection by.
    • embed - Comma separated list of resources to be contained within the current representation.
    method
    example

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

    Parameters

    • articleId: string

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

    • Optional options: IOptions

      Query resource options object.

    Returns any

get

  • Parses get route; this route should be expanded with the Id of the file resource.

    method
    example

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

    Parameters

    • articleId: string

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

    • id: string

      Article file id which uniquely identifies article file that needs to be retrieved.

    • Optional options: IGetRequestOptions

      options object that contains embed data.

    Returns any

link

  • Parses link route; this URI template does not expose any additional options.

    method
    example

    articleInstanceFilesRoute.link();

    Parameters

    • articleId: string

      Article slug or id which uniquely identifies article whose article files need to be deleted.

    • data: IArticleFile

    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

unlink

  • unlink(articleId: string, data: IArticleFile, options: Object): any

  • Parses unlink route; this URI template does not expose any additional options.

    method
    example

    articleFilesRoute.unlink(data);

    Parameters

    • articleId: string

      Article slug or id which uniquely identifies article whose article files need to be deleted.

    • data: IArticleFile
    • options: Object

    Returns any

unlinkByArticle

  • unlinkByArticle(articleId: string, data: IArticleFile, options?: any): any

  • Parses unlink by article route; this URI template does not expose any additional options.

    method
    example

    articleFilesRoute.unlinkByArticle(data);

    Parameters

    • articleId: string

      Article slug or id which uniquely identifies article whose article files need to be deleted.

    • data: IArticleFile
    • Optional options: any

    Returns any

update

  • Parses update route; this URI template does not expose any additional options.

    method
    example

    articleInstanceFilesRoute.update(data);

    Parameters

    Returns any

updateParams

  • updateParams(data: any): any

  • Parameters

    • data: any

    Returns any

Generated using TypeDoc