All Implemented Interfaces:

com.growsurf.api.core.Params
```
public final class CampaignListLeaderboardParams
 implements Params
                    
```
Retrieves participants in leaderboard order for the specified leaderboard type.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CampaignListLeaderboardParams.Builder`	A builder for CampaignListLeaderboardParams.
`public final class`	`CampaignListLeaderboardParams.LeaderboardType`	Leaderboard ordering mode.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`id()`
`final Optional<Boolean>`	`isMonthly()`	Deprecated.
`final Optional<CampaignListLeaderboardParams.LeaderboardType>`	`leaderboardType()`	Leaderboard ordering mode.
`final Optional<Long>`	`limit()`	Number of results to return.
`final Optional<String>`	`nextId()`	ID to start the next paged result set with.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final CampaignListLeaderboardParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CampaignListLeaderboardParams`	`none()`
`final static CampaignListLeaderboardParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of CampaignListLeaderboardParams.

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

- Constructor Detail
- Method Detail
  - id
```
 final Optional<String> id()
```
  - isMonthly
```
 final Optional<Boolean> isMonthly()
```
    Deprecated. Use leaderboardType=CURRENT_MONTH instead.
  - leaderboardType
```
 final Optional<CampaignListLeaderboardParams.LeaderboardType> leaderboardType()
```
    Leaderboard ordering mode.
  - limit
```
 final Optional<Long> limit()
```
    Number of results to return. Maximum 100.
  - nextId
```
 final Optional<String> nextId()
```
    ID to start the next paged result set with.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final CampaignListLeaderboardParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static CampaignListLeaderboardParams none()
```
  - builder
```
 final static CampaignListLeaderboardParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of CampaignListLeaderboardParams.

Class CampaignListLeaderboardParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

isMonthly

leaderboardType

limit

nextId

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder