Package video.api.client.api.clients

Class PlayerThemesApi.APIlistRequest

java.lang.Object

video.api.client.api.clients.PlayerThemesApi.APIlistRequest

Enclosing class:

PlayerThemesApi

public class PlayerThemesApi.APIlistRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for list
PlayerThemesApi.APIlistRequest	currentPage(Integer currentPage)	Set currentPage
Page<PlayerTheme>	execute()	Execute list request
okhttp3.Call	executeAsync(ApiCallback<Page<PlayerTheme>> _callback)	Execute list request (asynchronously)
ApiResponse<PlayerThemesListResponse>	executeWithHttpInfo()	Execute list request with HTTP info returned
PlayerThemesApi.APIlistRequest	pageSize(Integer pageSize)	Set pageSize
PlayerThemesApi.APIlistRequest	sortBy(String sortBy)	Set sortBy
PlayerThemesApi.APIlistRequest	sortOrder(String sortOrder)	Set sortOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

sortBy

public PlayerThemesApi.APIlistRequest sortBy(String sortBy)

Set sortBy

Parameters:

sortBy - createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. (optional)

Returns:

APIlistRequest

sortOrder

public PlayerThemesApi.APIlistRequest sortOrder(String sortOrder)

Set sortOrder

Parameters:

sortOrder - Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. (optional)

Returns:

APIlistRequest

currentPage

public PlayerThemesApi.APIlistRequest currentPage(Integer currentPage)

Set currentPage

Parameters:

currentPage - Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)

Returns:

APIlistRequest

pageSize

public PlayerThemesApi.APIlistRequest pageSize(Integer pageSize)

Set pageSize

Parameters:

pageSize - Results per page. Allowed values 1-100, default is 25. (optional, default to 25)

Returns:

APIlistRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for list

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

execute

public Page<PlayerTheme> execute()
                          throws ApiException

Execute list request

Returns:

PlayerThemesListResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

executeWithHttpInfo

public ApiResponse<PlayerThemesListResponse> executeWithHttpInfo()
                                                          throws ApiException

Execute list request with HTTP info returned

Returns:

ApiResponse<PlayerThemesListResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-

executeAsync

public okhttp3.Call executeAsync(ApiCallback<Page<PlayerTheme>> _callback)
                          throws ApiException

Execute list request (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-