FriendsParams

java.lang.Object
- com.cheetahdigital.corekit.rest.params.BaseParams
- - com.cheetahdigital.corekit.rest.params.BaseListQueryParams
  - - com.cheetahdigital.friends.core.api.FriendsParams

All Implemented Interfaces:

android.os.Parcelable
```
public class FriendsParams
extends BaseListQueryParams
```
Class for setting the query parameters of Friends API All Nullable parameters means you can remove the parameter by passing a null value.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FriendsParams.Builder
- Nested classes/interfaces inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams
  BaseListQueryParams.BaseListQueryBuilder<P extends BaseListQueryParams,B extends BaseListQueryParams.BaseListQueryBuilder>
- Nested classes/interfaces inherited from class com.cheetahdigital.corekit.rest.params.BaseParams
  BaseParams.BaseBuilder<T extends BaseParams,B extends BaseParams.BaseBuilder>
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields
Modifier and Type Field Description

static android.os.Parcelable.Creator<FriendsParams> CREATOR
- Fields inherited from class com.cheetahdigital.corekit.rest.params.BaseParams
  mId, mQueryMap
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Constructor Description

FriendsParams()

FriendsParams(android.os.Parcel in)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getLeaderboard()`	Get the current value of the leaderboard parameter
`void`	`setLeaderboard(java.lang.String leaderboard)`	Set the leaderboard to query

Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseListQueryParams
addCategories, addCategory, clearCategories, describeContents, getCategories, getItemsPerPage, getLayout, getPage, getSortBy, getSortOrder, removeCategory, setItemsPerPage, setLayout, setPage, setSortBy, setSortOrder, writeToParcel

Methods inherited from class com.cheetahdigital.corekit.rest.params.BaseParams
addParam, getAccessToken, getId, getParam, getQueryMap, setAccessToken, setId

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

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<FriendsParams> CREATOR
```
- Constructor Detail
  - FriendsParams
```
public FriendsParams()
```
  - FriendsParams
```
public FriendsParams(android.os.Parcel in)
```
- Method Detail
  - setLeaderboard
```
public void setLeaderboard(@Nullable
                           java.lang.String leaderboard)
```
    Set the leaderboard to query
    
    Parameters:
    
    leaderboard - leaderboard group
  - getLeaderboard
```
public java.lang.String getLeaderboard()
```
    Get the current value of the leaderboard parameter
    
    Returns:
    
    string containing the current value for leaderboard parameter, null if no value set