CategoryRecordsRequest (Spedran 1.0.2 API)

java.lang.Object
- com.treescrub.spedran.ResourceCollectionRequest<Leaderboard>
- - com.treescrub.spedran.requests.builders.CategoryRecordsRequest

public class CategoryRecordsRequest
extends ResourceCollectionRequest<Leaderboard>

A request builder to get the top runs of a Category.

Constructor Summary

Constructors
Constructor Description

CategoryRecordsRequest(Category category)

CategoryRecordsRequest(String id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CategoryRecordsRequest`	`keepEmptyResults()`	Keeps all leaderboards in the results, regardless of whether they have any runs.
`CategoryRecordsRequest`	`skipEmptyResults()`	Skips leaderboards if they do not contain any runs.
`CategoryRecordsRequest`	`topPlaces(int value)`	Sets number of places to return.

Methods inherited from class com.treescrub.spedran.ResourceCollectionRequest
complete

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CategoryRecordsRequest
```
public CategoryRecordsRequest(String id)
```
  - CategoryRecordsRequest
```
public CategoryRecordsRequest(Category category)
```
- Method Detail
  - topPlaces
```
public CategoryRecordsRequest topPlaces(int value)
```
    Sets number of places to return.
    This will return more than value runs per leaderboard if there are ties.
    
    Parameters:
    
    value - the top places to filter for, clamped to >= 1
    
    Returns:
    
    this object
  - skipEmptyResults
```
public CategoryRecordsRequest skipEmptyResults()
```
    Skips leaderboards if they do not contain any runs.
    
    Returns:
    
    this object
  - keepEmptyResults
```
public CategoryRecordsRequest keepEmptyResults()
```
    Keeps all leaderboards in the results, regardless of whether they have any runs.
    
    Returns:
    
    this object