Article slug or id which uniquely identifies article whose article files need to be retrieved.
Query resource options object.
A promise that is resolved once the find action has been performed.
Returns a promise that is resolved once the get action has been performed. Success response returns requested file resource.
Article slug or id which uniquely identifies article whose article files need to be retrieved.
Article file id which uniquely identifies article file that needs to be retrieved.
options object that contains embed data.
A promise that is resolved once the get action has been performed.
Returns a promise that is resolved once the link action has been performed; this action links file resource from other modules into the Article Files module (For example: file resources from the Media Vault module can be linked directly into the Article Files module).
Article slug or id which uniquely identifies article whose article files need to be linked.
A article file object that need to be inserted into the system.
A promise that is resolved once the link action has been performed.
Returns a promise that is resolved once the unlink action has been performed. This action will remove one or many file resources from the system if successfully completed. Specified file and all its accompanying derived resources will be removed from the system. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply baasicArticleFilesRouteService route template. Here is an example of how a route can be obtained from HAL enabled objects:
let params = modelMapper.removeParams(fileEntry);
let uri = params['model'].links('unlink').href;
Article slug or id which uniquely identifies article whose article files need to be deleted.
A promise that is resolved once the unlink action has been performed.
Returns a promise that is resolved once the unlink by article action has been performed. This action will remove all file resources from the system related to the requested article if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply baasicArticleService route template. Here is an example of how a route can be obtained from HAL enabled objects:
let params = modelMapper.removeParams(fileEntry);
let uri = params['model'].links('unlink-by-article').href;
Article slug or id which uniquely identifies article whose article files need to be deleted.
A promise that is resolved once the unlink by article action has been performed.
Returns a promise that is resolved once the update file action has been performed; this action will update a file resource if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply baasicArticleFilesRouteService
route template. Here is an example of how a route can be obtained from HAL enabled objects:
let params = modelMapper.updateParams(fileEntry);
let uri = params['model'].links('put').href;
An article object used to update specified article resource.
Article File object used to update specific article file data in the system.
A promise that is resolved once the update file action has been performed.
Generated using TypeDoc
Returns a promise that is resolved once the find action has been performed. Success response returns a list of file resources matching the given criteria.
articleInstanceFilesClient.find({ pageNumber : 1, pageSize : 10, orderBy : '',
orderDirection : '',
search : ''
})
.then(function (collection) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});