baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
96 lines (95 loc) • 6.15 kB
TypeScript
/**
* @module filesStreamsClient
* @description Files Streams Client provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Files Streams Route Definition to obtain needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.
*/
import { ApiClient, IHttpResponse } from '../../httpApi';
import { FilesStreamsRoute } from './';
export declare class FilesStreamsClient {
protected filesStreamsRoute: FilesStreamsRoute;
protected apiClient: ApiClient;
readonly routeDefinition: FilesStreamsRoute;
constructor(filesStreamsRoute: FilesStreamsRoute, apiClient: ApiClient);
/**
* 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
* @param id File id of the original file resource used to identify stream that needs to be retrieved from the system.
* @returns A promise that is resolved once the get action has been performed.
* @example // Request the original file stream
filesStreamsClient.get({id: '<path>'})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
// Request derived file stream
filesStreamsClient.get({id: '<path>', width: <width>, height: <height>, t: <timestamp>})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(data: any): PromiseLike<IHttpResponse<any>>;
/**
* 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](https://developer.mozilla.org/en-US/docs/Web/API/Blob).
* @method
* @example // Request the original blob
filesStreamsClient.getBlob('<path>')
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
// Request derived blob
filesStreamsClient.getBlob({id: '<path>', width: <width>, height: <height>, t: <timestamp>})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
getBlob(data: any): PromiseLike<IHttpResponse<any>>;
/**
* 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
filesStreamsClient.update('<path>', <file-stream>)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
// Update derived file stream
filesStreamsClient.update({id: '<path>', width: <width>, height: <height>}, <file-stream>)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: any, stream: any): PromiseLike<IHttpResponse<any>>;
/**
* 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](https://developer.mozilla.org/en-US/docs/Web/API/Blob).
* @method
* @example filesStreamsClient.create('<path>', <blob>)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
create(data: any, stream: any): PromiseLike<IHttpResponse<any>>;
}
/**
* @overview
***Notes:**
- Refer to the [REST API documentation](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- All end-point objects are transformed by the associated route service.
*/