Function getFeaturedList

  • Returns a list of all featured objects.

    Filter options

    • type - filter by type of the featured object,
    • memberId - filter by ID of the member who posted it,
    • gameId - filter by ID of the linked game,
    • gameTitle - filter by title of the linked game,
    • from - filter by being newer than a specified date,
    • to - filter by being older than a specified date.

    Sort options

    • date - sorts by date of posting.

    Usage

    const featuredAll: Featured[] = await sdk.getFeaturedList({ });
    const featuredVideos: Featured[] = await sdk.getFeaturedList({ filter: { type: FeaturedType.VIDEO }});
    const featuredLastWeek: Featured[] =
    await sdk.getFeaturedList({ sort: { from: 2019-07-07T16:38:19.000+00:00 }});

    Parameters

    Returns Promise<Featured[]>

Generated using TypeDoc