Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArticleInstanceFilesStreamsClient

Hierarchy

  • ArticleInstanceFilesStreamsClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected articleInstanceFilesStreamsRoute

articleInstanceFilesStreamsRoute: ArticleInstanceFilesStreamsRoute

Accessors

routeDefinition

Methods

create

  • Returns a promise that is resolved once the create file stream action has been performed; this action will upload the specified blob. For more information on Blob objects please see Blob Documentation.

    method
    example

    articleInstanceFilesStreamsClient.create('', ) .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 inserted.

    • data: IArticleFile

      Article File object that need to be inserted into the system.

    • stream: any

    Returns PromiseLike<IHttpResponse<any>>

    A promise that is resolved once the create file stream action has been performed.

get

  • Returns a promise that is resolved once the get action has been performed. Success response returns the file stream 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 return a stream of the derived resource. Otherwise, stream of the original file resource will be retrieved.

    method
    example

    // Request the original file stream articleInstanceFilesStreamsClient.get({id: ''}) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    // Request derived file stream articleInstanceFilesStreamsClient.get({id: '', width: , height: }) .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 retrieved.

    • data: IArticleFile

      Article File object used to identify stream that needs to be retrieved from the system.

    Returns PromiseLike<IHttpResponse<any>>

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

getBlob

  • Returns a promise that is resolved once the get action has been performed. Success response returns the file stream as a blob. If derived resource's format is passed, such as width and height for the image type of file resource, the operation will return a blob of the derived file resource. Otherwise, blob of the original file resource will be retrieved. For more information on Blob objects please see Blob Documentation.

    method
    example

    // Request the original blob articleInstanceFilesStreamsClient.getBlob('') .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    // Request derived blob articleInstanceFilesStreamsClient.getBlob({ id: '', width: , height: }) .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 retrieved.

    • data: IArticleFile

      Article File object used to identify stream that needs to be retrieved from the system.

    Returns PromiseLike<IHttpResponse<any>>

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

update

  • Returns a promise that is resolved once the update file stream action has been performed; this action will replace the existing stream with a new one. Alternatively, if a derived stream is being updated it will either create a new derived stream or replace the existing one. In order to update a derived stream, format needs to be passed (For example: width and height for the image type of file stream data type).

    method
    example

    // Update original file stream articleInstanceFilesStreamsClient.update('', ) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here }); // Update derived file stream articleInstanceFilesStreamsClient.update({id: '', width: , height: }, ) .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 used to identify stream that needs to be updated.

    • stream: any

    Returns PromiseLike<IHttpResponse<any>>

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

Generated using TypeDoc