CIOBrowseFacetsQuery

public struct CIOBrowseFacetsQuery : CIORequestData

Struct encapsulating the necessary and additional parameters required to execute a browse facets query.

  • The page of results to request (can’t be used with offset)

    Declaration

    Swift

    public let page: Int?

  • The offset of results to request (can’t be used with page)

    Declaration

    Swift

    public let offset: Int?

  • The number of results per page to return

    Declaration

    Swift

    public let perPage: Int?

  • Whether or not to return hidden facets

    Declaration

    Swift

    public let showHiddenFacets: Bool?

  • Create a Browse facets request query object

    Usage Example:

    let browseFacetsQuery = CIOBrowseFacetsQuery(page: 2, perPage: 30, showHiddenFacets: true)

    Declaration

    Swift

    public init(page: Int? = nil, offset: Int? = nil, perPage: Int? = nil, showHiddenFacets: Bool? = nil)

    Parameters

    page

    The page number of the results (can’t be used with offset)
    offset

    The offset of results to request (can’t be used with page)
    perPage

    The number of results per page to return
    showHiddenFacets

    Whether or not to return hidden facets