PlayerThemesApi (video.api:java-api-client 1.3.0 API)

java.lang.Object
- video.api.client.api.clients.PlayerThemesApi

public class PlayerThemesApi
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

class PlayerThemesApi.APIlistRequest

Nested Classes
Modifier and Type	Class	Description
`class`	`PlayerThemesApi.APIlistRequest`

Constructor Summary

Constructors
Constructor	Description
`PlayerThemesApi()`	Constructor for PlayerThemesApi production environment where API key is not required.
`PlayerThemesApi(String basePath)`	Constructor for PlayerThemesApi with custom API base path where API key is not required.
`PlayerThemesApi(String apiKey, String basePath)`	Constructor for PlayerThemesApi with custom API base path
`PlayerThemesApi(String apiKey, Environment environment)`	Constructor for PlayerThemesApi with custom API base path
`PlayerThemesApi(ApiClient apiClient)`
`PlayerThemesApi(Environment environment)`	Constructor for PlayerThemesApi with custom API base path where API key is not required.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PlayerTheme`	`create(PlayerThemeCreationPayload playerThemeCreationPayload)`	Create a player Create a player for your video, and customise it.
`okhttp3.Call`	`createAsync(PlayerThemeCreationPayload playerThemeCreationPayload, ApiCallback<PlayerTheme> _callback)`	Create a player (asynchronously) Create a player for your video, and customise it.
`ApiResponse<PlayerTheme>`	`createWithHttpInfo(PlayerThemeCreationPayload playerThemeCreationPayload)`	Create a player Create a player for your video, and customise it.
`void`	`delete(String playerId)`	Delete a player Delete a player if you no longer need it.
`okhttp3.Call`	`deleteAsync(String playerId, ApiCallback<Void> _callback)`	Delete a player (asynchronously) Delete a player if you no longer need it.
`void`	`deleteLogo(String playerId)`	Delete logo Delete the logo associated to a player.
`okhttp3.Call`	`deleteLogoAsync(String playerId, ApiCallback<Void> _callback)`	Delete logo (asynchronously) Delete the logo associated to a player.
`ApiResponse<Void>`	`deleteLogoWithHttpInfo(String playerId)`	Delete logo Delete the logo associated to a player.
`ApiResponse<Void>`	`deleteWithHttpInfo(String playerId)`	Delete a player Delete a player if you no longer need it.
`PlayerTheme`	`get(String playerId)`	Retrieve a player Retreive a player theme by player id.
`ApiClient`	`getApiClient()`
`okhttp3.Call`	`getAsync(String playerId, ApiCallback<PlayerTheme> _callback)`	Retrieve a player (asynchronously) Retreive a player theme by player id.
`ApiResponse<PlayerTheme>`	`getWithHttpInfo(String playerId)`	Retrieve a player Retreive a player theme by player id.
`PlayerThemesApi.APIlistRequest`	`list()`	List all player themes Retrieve a list of all the player themes you created, as well as details about each one.
`void`	`setApiClient(ApiClient apiClient)`
`PlayerTheme`	`update(String playerId, PlayerThemeUpdatePayload playerThemeUpdatePayload)`	Update a player Use a player ID to update specific details for a player.
`okhttp3.Call`	`updateAsync(String playerId, PlayerThemeUpdatePayload playerThemeUpdatePayload, ApiCallback<PlayerTheme> _callback)`	Update a player (asynchronously) Use a player ID to update specific details for a player.
`ApiResponse<PlayerTheme>`	`updateWithHttpInfo(String playerId, PlayerThemeUpdatePayload playerThemeUpdatePayload)`	Update a player Use a player ID to update specific details for a player.
`PlayerTheme`	`uploadLogo(String playerId, File file, String link)`	Upload a logo Upload an image logo for a player.
`okhttp3.Call`	`uploadLogoAsync(String playerId, File file, String link, ApiCallback<PlayerTheme> _callback)`	Upload a logo (asynchronously) Upload an image logo for a player.
`ApiResponse<PlayerTheme>`	`uploadLogoWithHttpInfo(String playerId, File file, String link)`	Upload a logo Upload an image logo for a player.

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

Constructor Detail
- PlayerThemesApi
```
public PlayerThemesApi(ApiClient apiClient)
```
- PlayerThemesApi
```
public PlayerThemesApi()
```
  Constructor for PlayerThemesApi production environment where API key is not required.
- PlayerThemesApi
```
public PlayerThemesApi(String basePath)
```
  Constructor for PlayerThemesApi with custom API base path where API key is not required.
  
  Parameters:
  
  basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.
- PlayerThemesApi
```
public PlayerThemesApi(Environment environment)
```
  Constructor for PlayerThemesApi with custom API base path where API key is not required.
  
  Parameters:
  
  environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.
- PlayerThemesApi
```
public PlayerThemesApi(String apiKey,
                       String basePath)
```
  Constructor for PlayerThemesApi with custom API base path
  
  Parameters:
  
  apiKey - the api key to use to authenticate to the API
  
  basePath - the api base path. Expected Environment.PRODUCTION.basePath (default) or Environment.SANDBOX.basePath.
- PlayerThemesApi
```
public PlayerThemesApi(String apiKey,
                       Environment environment)
```
  Constructor for PlayerThemesApi with custom API base path
  
  Parameters:
  
  apiKey - the api key to use to authenticate to the API
  
  environment - the target environment. Expected Environment.PRODUCTION (default) or Environment.SANDBOX.

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

create

public PlayerTheme create(PlayerThemeCreationPayload playerThemeCreationPayload)
                   throws ApiException

Create a player Create a player for your video, and customise it.

Parameters:

playerThemeCreationPayload - (required)

Returns:

PlayerTheme

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
201	Created	-

createWithHttpInfo

public ApiResponse<PlayerTheme> createWithHttpInfo(PlayerThemeCreationPayload playerThemeCreationPayload)
                                            throws ApiException

Create a player Create a player for your video, and customise it.

Parameters:

playerThemeCreationPayload - (required)

Returns:

ApiResponse<PlayerTheme>

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
201	Created	-

createAsync

public okhttp3.Call createAsync(PlayerThemeCreationPayload playerThemeCreationPayload,
                                ApiCallback<PlayerTheme> _callback)
                         throws ApiException

Create a player (asynchronously) Create a player for your video, and customise it.

Parameters:

playerThemeCreationPayload - (required)

_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
201	Created	-

get

public PlayerTheme get(String playerId)
                throws ApiException

Retrieve a player Retreive a player theme by player id.

Parameters:

playerId - The unique identifier for the player you want to retrieve. (required)

Returns:

PlayerTheme

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	-
404	Not Found	-

getWithHttpInfo

public ApiResponse<PlayerTheme> getWithHttpInfo(String playerId)
                                         throws ApiException

Retrieve a player Retreive a player theme by player id.

Parameters:

playerId - The unique identifier for the player you want to retrieve. (required)

Returns:

ApiResponse<PlayerTheme>

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	-
404	Not Found	-

getAsync

public okhttp3.Call getAsync(String playerId,
                             ApiCallback<PlayerTheme> _callback)
                      throws ApiException

Retrieve a player (asynchronously) Retreive a player theme by player id.

Parameters:

playerId - The unique identifier for the player you want to retrieve. (required)

_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	-
404	Not Found	-

update

public PlayerTheme update(String playerId,
                          PlayerThemeUpdatePayload playerThemeUpdatePayload)
                   throws ApiException

Update a player Use a player ID to update specific details for a player. NOTE: It may take up to 10 min before the new player configuration is available from our CDN.

Parameters:

playerId - The unique identifier for the player. (required)

playerThemeUpdatePayload - (required)

Returns:

PlayerTheme

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	-
404	Not Found	-

updateWithHttpInfo

public ApiResponse<PlayerTheme> updateWithHttpInfo(String playerId,
                                                   PlayerThemeUpdatePayload playerThemeUpdatePayload)
                                            throws ApiException

Update a player Use a player ID to update specific details for a player. NOTE: It may take up to 10 min before the new player configuration is available from our CDN.

Parameters:

playerId - The unique identifier for the player. (required)

playerThemeUpdatePayload - (required)

Returns:

ApiResponse<PlayerTheme>

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	-
404	Not Found	-

updateAsync

public okhttp3.Call updateAsync(String playerId,
                                PlayerThemeUpdatePayload playerThemeUpdatePayload,
                                ApiCallback<PlayerTheme> _callback)
                         throws ApiException

Update a player (asynchronously) Use a player ID to update specific details for a player. NOTE: It may take up to 10 min before the new player configuration is available from our CDN.

Parameters:

playerId - The unique identifier for the player. (required)

playerThemeUpdatePayload - (required)

_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	-
404	Not Found	-

delete

public void delete(String playerId)
            throws ApiException

Delete a player Delete a player if you no longer need it. You can delete any player that you have the player ID for.

Parameters:

playerId - The unique identifier for the player you want to delete. (required)

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
204	No Content	-
404	Not Found	-

deleteWithHttpInfo

public ApiResponse<Void> deleteWithHttpInfo(String playerId)
                                     throws ApiException

Delete a player Delete a player if you no longer need it. You can delete any player that you have the player ID for.

Parameters:

playerId - The unique identifier for the player you want to delete. (required)

Returns:

ApiResponse<Void>

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
204	No Content	-
404	Not Found	-

deleteAsync

public okhttp3.Call deleteAsync(String playerId,
                                ApiCallback<Void> _callback)
                         throws ApiException

Delete a player (asynchronously) Delete a player if you no longer need it. You can delete any player that you have the player ID for.

Parameters:

playerId - The unique identifier for the player you want to delete. (required)

_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
204	No Content	-
404	Not Found	-

list

public PlayerThemesApi.APIlistRequest list()

List all player themes Retrieve a list of all the player themes you created, as well as details about each one.

Returns:

APIlistRequest

Http Response Details:

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

uploadLogo

public PlayerTheme uploadLogo(String playerId,
                              File file,
                              String link)
                       throws ApiException

Upload a logo Upload an image logo for a player.

Parameters:

playerId - The unique identifier for the player. (required)

file - The name of the file you want to use for your logo. (required)

link - A public link that you want to advertise in your player. For example, you could add a link to your company. When a viewer clicks on your logo, they will be taken to this address. (optional)

Returns:

PlayerTheme

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
201	Created	-
400	Bad Request	-
404	Not Found	-

uploadLogoWithHttpInfo

public ApiResponse<PlayerTheme> uploadLogoWithHttpInfo(String playerId,
                                                       File file,
                                                       String link)
                                                throws ApiException

Upload a logo Upload an image logo for a player.

Parameters:

playerId - The unique identifier for the player. (required)

file - The name of the file you want to use for your logo. (required)

link - A public link that you want to advertise in your player. For example, you could add a link to your company. When a viewer clicks on your logo, they will be taken to this address. (optional)

Returns:

ApiResponse<PlayerTheme>

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
201	Created	-
400	Bad Request	-
404	Not Found	-

uploadLogoAsync

public okhttp3.Call uploadLogoAsync(String playerId,
                                    File file,
                                    String link,
                                    ApiCallback<PlayerTheme> _callback)
                             throws ApiException

Upload a logo (asynchronously) Upload an image logo for a player.

Parameters:

playerId - The unique identifier for the player. (required)

file - The name of the file you want to use for your logo. (required)

link - A public link that you want to advertise in your player. For example, you could add a link to your company. When a viewer clicks on your logo, they will be taken to this address. (optional)

_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
201	Created	-
400	Bad Request	-
404	Not Found	-

deleteLogo

public void deleteLogo(String playerId)
                throws ApiException

Delete logo Delete the logo associated to a player.

Parameters:

playerId - The unique identifier for the player. (required)

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
204	No Content	-
404	Not Found	-

deleteLogoWithHttpInfo

public ApiResponse<Void> deleteLogoWithHttpInfo(String playerId)
                                         throws ApiException

Delete logo Delete the logo associated to a player.

Parameters:

playerId - The unique identifier for the player. (required)

Returns:

ApiResponse<Void>

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
204	No Content	-
404	Not Found	-

deleteLogoAsync

public okhttp3.Call deleteLogoAsync(String playerId,
                                    ApiCallback<Void> _callback)
                             throws ApiException

Delete logo (asynchronously) Delete the logo associated to a player.

Parameters:

playerId - The unique identifier for the player. (required)

_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
204	No Content	-
404	Not Found	-

Class PlayerThemesApi

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlayerThemesApi

PlayerThemesApi

PlayerThemesApi

PlayerThemesApi

PlayerThemesApi

PlayerThemesApi

Method Detail

getApiClient

setApiClient

create

createWithHttpInfo

createAsync

get

getWithHttpInfo

getAsync

update

updateWithHttpInfo

updateAsync

delete

deleteWithHttpInfo

deleteAsync

list

uploadLogo

uploadLogoWithHttpInfo

uploadLogoAsync

deleteLogo

deleteLogoWithHttpInfo

deleteLogoAsync