OpenXchangeClient.Api.Jobqueue (open_xchange_client v0.10.0)
API calls for all endpoints tagged Jobqueue
.
Link to this section Summary
Functions
Get all user's jobs
Cancels a certain job held in job queue
Gets the result of a certain job
Gets the informartion about a certain job held in job queue
Link to this section Functions
Link to this function
all_jobs(connection, session, opts \\ [])
@spec all_jobs(Tesla.Env.client(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.AllJobsResponse.t()} | {:error, Tesla.Env.t()}
Get all user's jobs
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
cancel_job(connection, session, id, opts \\ [])
@spec cancel_job(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.CancelJobResponse.t()} | {:error, Tesla.Env.t()}
Cancels a certain job held in job queue
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- id (String.t): The identifier for the job
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
get_job(connection, session, id, opts \\ [])
@spec get_job(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.GetJobResponse.t()} | {:ok, String.t()} | {:error, Tesla.Env.t()}
Gets the result of a certain job
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- id (String.t): The identifier for the job
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
info_job(connection, session, id, opts \\ [])
@spec info_job(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, OpenXchangeClient.Model.InfoJobResponse.t()} | {:error, Tesla.Env.t()}
Gets the informartion about a certain job held in job queue
parameters
Parameters
- connection (OpenXchangeClient.Connection): Connection to server
- session (String.t): A session ID previously obtained from the login module.
- id (String.t): The identifier for the job
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure