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

new MediaService()

new MediaService(): MediaService

Returns

MediaService

Methods

chunkUploadMedia()

static chunkUploadMedia(data, bytesStart, bytesEnd, bytesTotal, config?): Promise<SCChunkMediaType>

Parameters

Parameter	Type
data	ChunkUploadParams
bytesStart	number
bytesEnd	number
bytesTotal	number
config?	AxiosRequestConfig<any>

Returns

Promise<SCChunkMediaType>

Source

services/media/index.ts:144

---

chunkUploadMediaComplete()

static chunkUploadMediaComplete(data, config?): Promise<SCMediaType>

Parameters

Parameter	Type
data	ChunkUploadCompleteParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCMediaType>

Source

services/media/index.ts:154

---

clickMedia()

static clickMedia(id, ip?, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
ip?	string
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/media/index.ts:162

---

createMedia()

static createMedia(data, config?): Promise<SCMediaType>

Parameters

Parameter	Type
data	MediaCreateParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCMediaType>

Source

services/media/index.ts:158

---

deleteMedia()

static deleteMedia(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/media/index.ts:174

---

getSpecificMedia()

static getSpecificMedia(id, config?): Promise<SCMediaType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCMediaType>

Source

services/media/index.ts:166

---

updateMedia()

static updateMedia(id, image, config?): Promise<SCMediaType>

Parameters

Parameter	Type
id	string | number
image	string
config?	AxiosRequestConfig<any>

Returns

Promise<SCMediaType>

Source

services/media/index.ts:170