Skip to main content

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

FeedService

Methods

getExploreFeed

getExploreFeed(params?, config?): Promise<SCPaginatedResponse<SCFeedUnitType>>

Parameters

NameType
params?FeedParams
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/feed/index.ts:106


getMainFeed

getMainFeed(params?, config?): Promise<SCPaginatedResponse<SCFeedUnitType>>

Parameters

NameType
params?FeedParams
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/feed/index.ts:103


getMainFeedUnseenCount

getMainFeedUnseenCount(config?): Promise<SCFeedUnseenCountType>

Parameters

NameType
config?AxiosRequestConfig<any>

Returns

Promise<SCFeedUnseenCountType>

Defined in

services/feed/index.ts:110


likeFeedObjs

likeFeedObjs(object, config?): Promise<SCPaginatedResponse<SCFeedUnitType>>

Parameters

NameType
objectnumber[]
config?AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/feed/index.ts:116


markReadASpecificFeedObj

markReadASpecificFeedObj(object, config?): Promise<any>

Parameters

NameType
objectnumber[]
config?AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/feed/index.ts:113