Class: FeedService
services/feed.FeedService
Feed service can be used in the following way:
1. Import the service from our library:
import {FeedService} from "@selfcommunity/api-services";
2. Create a function and put the service inside it!
The async function `getMainFeed` will return the paginated list of main feed posts.
async getMainFeed() {
return await FeedService.getMainFeed();
}
In case of required `params`, just add them inside the brackets.
async likeFeedObjs(objIds) {
return await FeedService.likeFeedObjs(objIds);
}
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 FeedService(): FeedService
Returns
Methods
getExploreFeed
▸ getExploreFeed(params?
, config?
): Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Parameters
Name | Type |
---|---|
params? | FeedParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Defined in
getMainFeed
▸ getMainFeed(params?
, config?
): Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Parameters
Name | Type |
---|---|
params? | FeedParams |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Defined in
getMainFeedUnseenCount
▸ getMainFeedUnseenCount(config?
): Promise
<SCFeedUnseenCountType
>
Parameters
Name | Type |
---|---|
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCFeedUnseenCountType
>
Defined in
likeFeedObjs
▸ likeFeedObjs(object
, config?
): Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Parameters
Name | Type |
---|---|
object | number [] |
config? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCFeedUnitType
>>
Defined in
markReadASpecificFeedObj
▸ markReadASpecificFeedObj(object
, config?
): Promise
<any
>
Parameters
Name | Type |
---|---|
object | number [] |
config? | AxiosRequestConfig <any > |
Returns
Promise
<any
>