Package com.w3asel.inventree.api

Class ActionApi

java.lang.Object

com.w3asel.inventree.api.ActionApi

public class ActionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ActionApi()
ActionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ActionPlugin	actionCreate(ActionPlugin actionPlugin)	This function checks if all required info was submitted and then performs a plugin_action or returns an error.
okhttp3.Call	actionCreateAsync(ActionPlugin actionPlugin, ApiCallback<ActionPlugin> _callback)	(asynchronously) This function checks if all required info was submitted and then performs a plugin_action or returns an error.
okhttp3.Call	actionCreateCall(ActionPlugin actionPlugin, ApiCallback _callback)	Build call for actionCreate
ApiResponse<ActionPlugin>	actionCreateWithHttpInfo(ActionPlugin actionPlugin)	This function checks if all required info was submitted and then performs a plugin_action or returns an error.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Details

ActionApi

public ActionApi()

ActionApi

public ActionApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

actionCreateCall

public okhttp3.Call actionCreateCall(@Nonnull
 ActionPlugin actionPlugin,
 ApiCallback _callback)
                              throws ApiException

Build call for actionCreate

Parameters:

actionPlugin - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200		-

actionCreate

public ActionPlugin actionCreate(@Nonnull
 ActionPlugin actionPlugin)
                          throws ApiException

This function checks if all required info was submitted and then performs a plugin_action or returns an error.

Parameters:

actionPlugin - (required)

Returns:

ActionPlugin

Throws:

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

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200		-

actionCreateWithHttpInfo

public ApiResponse<ActionPlugin> actionCreateWithHttpInfo(@Nonnull
 ActionPlugin actionPlugin)
                                                   throws ApiException

This function checks if all required info was submitted and then performs a plugin_action or returns an error.

Parameters:

actionPlugin - (required)

Returns:

ApiResponse<ActionPlugin>

Throws:

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

HTTP Response Details:

Response Details

Status Code	Description	Response Headers
200		-

actionCreateAsync

public okhttp3.Call actionCreateAsync(@Nonnull
 ActionPlugin actionPlugin,
 ApiCallback<ActionPlugin> _callback)
                               throws ApiException

(asynchronously) This function checks if all required info was submitted and then performs a plugin_action or returns an error.

Parameters:

actionPlugin - (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:

Response Details

Status Code	Description	Response Headers
200		-