MediaService
Media service can be used in the following way:
1. Import the service from our library:
import {MediaService} from "@selfcommunity/api-services";
2. Create a function and put the service inside it!
The async function `createMedia` will return the created media obj. It takes a media obj as body param.
async createMedia() {
const body = {url: 'string', type: 'url'};
return await MediaService.createMedia(body);
}
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
1. Declare it(or declare them, it is possible to add multiple params)
const headers = headers: {Authorization: `Bearer ${yourToken}`}
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
Constructors
Constructor
new MediaService():
MediaService
Returns
MediaService
Methods
chunkUploadMedia()
staticchunkUploadMedia(data,bytesStart,bytesEnd,bytesTotal,config?):Promise<SCChunkMediaType>
Parameters
| Parameter | Type |
|---|---|
data | ChunkUploadParams |
bytesStart | number |
bytesEnd | number |
bytesTotal | number |
config? | AxiosRequestConfig |
Returns
Promise<SCChunkMediaType>
chunkUploadMediaComplete()
staticchunkUploadMediaComplete(data,config?):Promise<SCMediaType>
Parameters
| Parameter | Type |
|---|---|
data | ChunkUploadCompleteParams |
config? | AxiosRequestConfig |
Returns
Promise<SCMediaType>
clickMedia()
staticclickMedia(id,ip?,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
ip? | string |
config? | AxiosRequestConfig |
Returns
Promise<any>
createMedia()
staticcreateMedia(data,config?):Promise<SCMediaType>
Parameters
| Parameter | Type |
|---|---|
data | MediaCreateParams |
config? | AxiosRequestConfig |
Returns
Promise<SCMediaType>
deleteMedia()
staticdeleteMedia(id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
getSpecificMedia()
staticgetSpecificMedia(id,config?):Promise<SCMediaType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCMediaType>
updateMedia()
staticupdateMedia(id,image,config?):Promise<SCMediaType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
image | string |
config? | AxiosRequestConfig |
Returns
Promise<SCMediaType>