RankingsQuery
struct RankingsQuery : Codable, Hashable, ServiceProvider
extension RankingsQuery: CustomStringConvertible
extension RankingsQuery: CustomDebugStringConvertible
Rankings query for API endpoints
-
Constant for all locations
Declaration
Swift
static let allLocations: Int
-
checklistKey
Declaration
Swift
var checklistKey: String
-
ageGroup
Declaration
Swift
var ageGroup: Age
-
countryId
Declaration
Swift
var countryId: Int?
-
facebookConnected
Declaration
Swift
var facebookConnected: Bool
-
gender
Declaration
Swift
var gender: Gender
-
locationId
Declaration
Swift
var locationId: Int?
-
Copy changing list and page
Declaration
Swift
func with(list: Checklist? = nil, page: Int = 1) -> RankingsQuery
Parameters
list
Checklist
page
Index
Return Value
New query
-
Initalize for checklist
Declaration
Swift
init(list: Checklist = .locations)
Parameters
list
Checklist
-
Declaration
Swift
var description: String { get }
-
Declaration
Swift
var debugDescription: String { get }
-
Checklist this query is for
Declaration
Swift
var checklist: Checklist { get }
-
Query key
Declaration
Swift
var queryKey: String { get }
-
Unique storage key
Declaration
Swift
var dbKey: String { get }
-
Convenience accessor for overall rankings query
Declaration
Swift
var isAllTravelers: Bool { get }
-
Provides API parameters
Declaration
Swift
var parameters: [String : String] { get }
-
Update with new geography
Declaration
Swift
mutating func update(with item: Object) -> Bool
Parameters
item
Country or Location expected
Return Value
Success