@amityco/ts-sdk/dist/feedRepository/observers/getCommunityFeed.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { FeedRepository } from '@amityco/ts-sdk'
 *
 * let posts = []
 * const unsubscribe = FeedRepository.getCommunityFeed({
 *   communityId: 'community-id',
 *   sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated',
 *   includeDeleted?: boolean,
 *   feedType?: 'reviewing' | 'published' | 'declined',
 *   tags?: string[],
 *   includeMixedStructure?: boolean,
 *   limit?: number,
 * }, response => processResponse(response))
 * ```
 *
 * Observe all mutations on a list of {@link Amity.Post} for a given community feed.
 *
 * @param params - Parameters for querying the community feed:
 *   @param params.communityId The ID of the community (required)
 *   @param params.sortBy The sorting order of the feed (optional)
 *   @param params.includeDeleted Whether to include deleted posts (optional)
 *   @param params.feedType The type of the feed: 'reviewing', 'published', or 'declined' (optional)
 *   @param params.tags Array of tags to filter posts (optional)
 *   @param params.includeMixedStructure Whether to include mixed structure posts (optional)
 *   @param params.limit The maximum number of posts to retrieve (optional)
 * @param callback The function to call when new data are available
 * @param config Additional live collection configuration (optional)
 * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the feed
 *
 * @category Posts Live Collection
 */
export declare const getCommunityFeed: (params: Amity.CommunityFeedLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Post>, config?: Amity.LiveCollectionConfig) => Amity.Unsubscriber;
//# sourceMappingURL=getCommunityFeed.d.ts.map