Class: EmbedService
services/embed.EmbedService
1. Import the service from our library:
import {EmbedService} from "@selfcommunity/api-services";
2. Create a function and put the service inside it!
The async function `getAllEmbeds` will return the paginated list of embeds.
async getAllEmbeds() {
return await EmbedService.getAllEmbeds();
}
In case of required `params`, just add them inside the brackets.
async getSpecificEmbed(embedId) {
return await EmbedService.getSpecificEmbed(embedId);
}
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 EmbedService(): EmbedService
Returns
Methods
createEmbed
▸ createEmbed(data
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
data | SCEmbedType |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>
Defined in
getAllEmbeds
▸ getAllEmbeds(params?
, config?
): Promise
<SCPaginatedResponse
<SCEmbedType
>>
Parameters
Name | Type |
---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCEmbedType
>>
Defined in
getEmbedFeed
▸ getEmbedFeed(embed_type?
, embed_id?
, config?
): Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Parameters
Name | Type |
---|---|
embed_type? | string |
embed_id? | string |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Defined in
getSpecificEmbed
▸ getSpecificEmbed(id
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>
Defined in
getSpecificEmbedFeed
▸ getSpecificEmbedFeed(id
, config?
): Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Parameters
Name | Type |
---|---|
id | string | number |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Defined in
patchASpecificEmbed
▸ patchASpecificEmbed(id
, data?
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
id | string | number |
data? | EmbedUpdateParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>
Defined in
searchEmbed
▸ searchEmbed(params?
, config?
): Promise
<SCPaginatedResponse
<SCEmbedType
>>
Parameters
Name | Type |
---|---|
params? | EmbedSearchParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCEmbedType
>>
Defined in
updateASpecificEmbed
▸ updateASpecificEmbed(id
, data?
, config?
): Promise
<SCEmbedType
>
Parameters
Name | Type |
---|---|
id | string | number |
data? | EmbedUpdateParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCEmbedType
>