PostSearchData

public struct PostSearchData : Content

Used to return info about a search for ForumPosts. Like forums, this returns an array of PostData. However, this gives the results of a search for posts across all the forums.

Returned by: GET /api/v3/forum/post/search

Show on GitHub

  • The search query used to create these results.

    Declaration

    Swift

    var queryString: String
    Show on GitHub

  • The total number of posts in the result set. The actual # of results returned may be fewer than this, even if we return ‘complete’ results. This is due to additional filtering that is done after the database query. See notes on ContentFilterable.filterForMention(of:)

    Declaration

    Swift

    var totalPosts: Int
    Show on GitHub

  • The index into totalPosts of the first post in the posts array. 0 is the index of the first result. This number is usually a multiple of limit and indicates the page of results.

    Declaration

    Swift

    var start: Int
    Show on GitHub

  • The number of posts the server attempted to gather. posts.count may be less than this number if posts were filtered out by post-query filtering, or if start + limit > totalPosts.

    Declaration

    Swift

    var limit: Int
    Show on GitHub

  • The posts in the forum.

    Declaration

    Swift

    var posts: [PostData]
    Show on GitHub