Class: MediaService
services/media.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
Methods
chunkUploadMedia
▸ chunkUploadMedia(data, bytesStart, bytesEnd, bytesTotal, config?): Promise<SCChunkMediaType>
Parameters
| Name | Type |
|---|---|
data | ChunkUploadParams |
bytesStart | number |
bytesEnd | number |
bytesTotal | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCChunkMediaType>
Defined in
chunkUploadMediaComplete
▸ chunkUploadMediaComplete(data, config?): Promise<SCMediaType>
Parameters
| Name | Type |
|---|---|
data | ChunkUploadCompleteParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>
Defined in
clickMedia
▸ clickMedia(id, ip?, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
id | string | number |
ip? | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
createMedia
▸ createMedia(data, config?): Promise<SCMediaType>
Parameters
| Name | Type |
|---|---|
data | MediaCreateParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>
Defined in
deleteMedia
▸ deleteMedia(id, config?): Promise<any>
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
getSpecificMedia
▸ getSpecificMedia(id, config?): Promise<SCMediaType>
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>
Defined in
updateMedia
▸ updateMedia(id, image, config?): Promise<SCMediaType>
Parameters
| Name | Type |
|---|---|
id | string | number |
image | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCMediaType>