Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ArticleInstanceFilesBatchClient

Index

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected articleInstanceFilesBatchRoute

articleInstanceFilesBatchRoute: ArticleInstanceFilesBatchRoute

Accessors

routeDefinition

Methods

link

  • Returns a promise that is resolved once the link action has been performed; this action links file resources from other modules into the Files module (For example: file resources from the Media Vault module can be linked directly into the Files module).

    method
    example

    articleInstanceFilesBatchClient.link(files) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • articleId: string

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

    • data: IArticleFile[]

      A collection of article file objects that need to be inserted into the system.

    Returns PromiseLike<IHttpResponse<any>>

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

unlink

  • Returns a promise that is resolved once the unlink action has been performed. This action will remove file resources from the system if successfully completed. If derived resource's format is passed, such as width and height for the image type of file resource, the operation will remove just derived resource. Otherwise, specified file and all its accompanying derived resources will be removed from the system.

    method
    example

    // Remove original file resources articleInstanceFilesBatchClient.unlink([{ id: '' }]) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here }); // Remove derived file resources articleInstanceFilesBatchClient.unlink([{ id: '', fileFormat: { width: , height: } }]) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • articleId: string

      Article file id of the original article file used to identify article files on which delete action should be performed.

    • data: IArticleFile[]

      Collection of article delete requests which uniquely identifies article files that need to be deleted.

    Returns PromiseLike<IHttpResponse<void>>

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

update

  • Returns a promise that is resolved once the update action has been performed; this action updates specified file resources.

    method
    example

    articleInstanceFilesBatchClient.update(files) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • articleId: string

      Article slug or id which uniquely identifies article whose article file need to be updated.

    • data: IArticleFile[]

      Article file object that need to be updated in the system.

    Returns PromiseLike<IHttpResponse<void>>

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

Generated using TypeDoc