CIOBrowseGroupsQuery

public struct CIOBrowseGroupsQuery : CIORequestData

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

  • The id of the specific group that should be included in the response

    Declaration

    Swift

    public let groupId: String?

  • The section to return results from

    Declaration

    Swift

    public let section: String

  • The maximum depth of the hierarchy, in case of hierarchical groups, that should be included in the response

    Declaration

    Swift

    public let groupsMaxDepth: Int?

  • Create a Browse Groups request query object

    Usage Example:

    let browseGroupsQuery = CIOBrowseGroupsQuery(
   groupId: "group_1",
   section: "Products",
   groupsMaxDepth: 5
)

    Declaration

    Swift

    public init(groupId: String? = nil, section: String? = nil, groupsMaxDepth: Int? = nil)

    Parameters

    groupId

    The id of the specific group that should be included in the response
    section

    The section to return results from
    groupsMaxDepth

    The maximum depth of the hierarchy, in case of hierarchical groups, that should be included in the response