public class WaitForControllerApi extends Object
| Constructor and Description |
|---|
WaitForControllerApi() |
WaitForControllerApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
ApiClient |
getApiClient() |
void |
setApiClient(ApiClient apiClient) |
List<EmailPreview> |
waitFor(WaitForConditions waitForConditions)
Wait for conditions to be met
Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
|
okhttp3.Call |
waitForAsync(WaitForConditions waitForConditions,
ApiCallback<List<EmailPreview>> _callback)
Wait for conditions to be met (asynchronously)
Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
|
okhttp3.Call |
waitForCall(WaitForConditions waitForConditions,
ApiCallback _callback)
Build call for waitFor
|
List<EmailPreview> |
waitForEmailCount(Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait for and return count number of emails
If inbox contains count or more emails at time of request then return count worth of emails.
|
okhttp3.Call |
waitForEmailCountAsync(Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<List<EmailPreview>> _callback)
Wait for and return count number of emails (asynchronously)
If inbox contains count or more emails at time of request then return count worth of emails.
|
okhttp3.Call |
waitForEmailCountCall(Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForEmailCount
|
ApiResponse<List<EmailPreview>> |
waitForEmailCountWithHttpInfo(Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait for and return count number of emails
If inbox contains count or more emails at time of request then return count worth of emails.
|
Email |
waitForLatestEmail(UUID inboxId,
Long timeout,
Boolean unreadOnly)
Fetch inbox's latest email or if empty wait for an email to arrive
Will return either the last received email or wait for an email to arrive and return that.
|
okhttp3.Call |
waitForLatestEmailAsync(UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<Email> _callback)
Fetch inbox's latest email or if empty wait for an email to arrive (asynchronously)
Will return either the last received email or wait for an email to arrive and return that.
|
okhttp3.Call |
waitForLatestEmailCall(UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForLatestEmail
|
ApiResponse<Email> |
waitForLatestEmailWithHttpInfo(UUID inboxId,
Long timeout,
Boolean unreadOnly)
Fetch inbox's latest email or if empty wait for an email to arrive
Will return either the last received email or wait for an email to arrive and return that.
|
List<EmailPreview> |
waitForMatchingEmail(MatchOptions matchOptions,
Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait or return list of emails that match simple matching patterns
Perform a search of emails in an inbox with the given patterns.
|
okhttp3.Call |
waitForMatchingEmailAsync(MatchOptions matchOptions,
Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<List<EmailPreview>> _callback)
Wait or return list of emails that match simple matching patterns (asynchronously)
Perform a search of emails in an inbox with the given patterns.
|
okhttp3.Call |
waitForMatchingEmailCall(MatchOptions matchOptions,
Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForMatchingEmail
|
ApiResponse<List<EmailPreview>> |
waitForMatchingEmailWithHttpInfo(MatchOptions matchOptions,
Integer count,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait or return list of emails that match simple matching patterns
Perform a search of emails in an inbox with the given patterns.
|
Email |
waitForMatchingFirstEmail(MatchOptions matchOptions,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait for or return the first email that matches proved MatchOptions array
Perform a search of emails in an inbox with the given patterns.
|
okhttp3.Call |
waitForMatchingFirstEmailAsync(MatchOptions matchOptions,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback<Email> _callback)
Wait for or return the first email that matches proved MatchOptions array (asynchronously)
Perform a search of emails in an inbox with the given patterns.
|
okhttp3.Call |
waitForMatchingFirstEmailCall(MatchOptions matchOptions,
UUID inboxId,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForMatchingFirstEmail
|
ApiResponse<Email> |
waitForMatchingFirstEmailWithHttpInfo(MatchOptions matchOptions,
UUID inboxId,
Long timeout,
Boolean unreadOnly)
Wait for or return the first email that matches proved MatchOptions array
Perform a search of emails in an inbox with the given patterns.
|
Email |
waitForNthEmail(UUID inboxId,
Integer index,
Long timeout,
Boolean unreadOnly)
Wait for or fetch the email with a given index in the inbox specified
If nth email is already present in inbox then return it.
|
okhttp3.Call |
waitForNthEmailAsync(UUID inboxId,
Integer index,
Long timeout,
Boolean unreadOnly,
ApiCallback<Email> _callback)
Wait for or fetch the email with a given index in the inbox specified (asynchronously)
If nth email is already present in inbox then return it.
|
okhttp3.Call |
waitForNthEmailCall(UUID inboxId,
Integer index,
Long timeout,
Boolean unreadOnly,
ApiCallback _callback)
Build call for waitForNthEmail
|
ApiResponse<Email> |
waitForNthEmailWithHttpInfo(UUID inboxId,
Integer index,
Long timeout,
Boolean unreadOnly)
Wait for or fetch the email with a given index in the inbox specified
If nth email is already present in inbox then return it.
|
ApiResponse<List<EmailPreview>> |
waitForWithHttpInfo(WaitForConditions waitForConditions)
Wait for conditions to be met
Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
|
public WaitForControllerApi()
public WaitForControllerApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call waitForCall(WaitForConditions waitForConditions, ApiCallback _callback) throws ApiException
waitForConditions - Conditions to wait for (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public List<EmailPreview> waitFor(WaitForConditions waitForConditions) throws ApiException
waitForConditions - Conditions to wait for (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<List<EmailPreview>> waitForWithHttpInfo(WaitForConditions waitForConditions) throws ApiException
waitForConditions - Conditions to wait for (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForAsync(WaitForConditions waitForConditions, ApiCallback<List<EmailPreview>> _callback) throws ApiException
waitForConditions - Conditions to wait for (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForEmailCountCall(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback _callback) throws ApiException
count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public List<EmailPreview> waitForEmailCount(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<List<EmailPreview>> waitForEmailCountWithHttpInfo(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForEmailCountAsync(Integer count, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback<List<EmailPreview>> _callback) throws ApiException
count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForLatestEmailCall(UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback _callback) throws ApiException
inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only. (optional, default to false)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public Email waitForLatestEmail(UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only. (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<Email> waitForLatestEmailWithHttpInfo(UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only. (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForLatestEmailAsync(UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback<Email> _callback) throws ApiException
inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only. (optional, default to false)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForMatchingEmailCall(MatchOptions matchOptions, Integer count, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback _callback) throws ApiException
matchOptions - matchOptions (required)count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public List<EmailPreview> waitForMatchingEmail(MatchOptions matchOptions, Integer count, UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
matchOptions - matchOptions (required)count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<List<EmailPreview>> waitForMatchingEmailWithHttpInfo(MatchOptions matchOptions, Integer count, UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
matchOptions - matchOptions (required)count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForMatchingEmailAsync(MatchOptions matchOptions, Integer count, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback<List<EmailPreview>> _callback) throws ApiException
matchOptions - matchOptions (required)count - Number of emails to wait for. Must be greater that 1 (optional)inboxId - Id of the inbox we are fetching emails from (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForMatchingFirstEmailCall(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback _callback) throws ApiException
matchOptions - matchOptions (required)inboxId - Id of the inbox we are matching an email for (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public Email waitForMatchingFirstEmail(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
matchOptions - matchOptions (required)inboxId - Id of the inbox we are matching an email for (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<Email> waitForMatchingFirstEmailWithHttpInfo(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly) throws ApiException
matchOptions - matchOptions (required)inboxId - Id of the inbox we are matching an email for (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForMatchingFirstEmailAsync(MatchOptions matchOptions, UUID inboxId, Long timeout, Boolean unreadOnly, ApiCallback<Email> _callback) throws ApiException
matchOptions - matchOptions (required)inboxId - Id of the inbox we are matching an email for (optional)timeout - Max milliseconds to wait (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForNthEmailCall(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, ApiCallback _callback) throws ApiException
inboxId - Id of the inbox you are fetching emails from (optional)index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)timeout - Max milliseconds to wait for the nth email if not already present (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public Email waitForNthEmail(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly) throws ApiException
inboxId - Id of the inbox you are fetching emails from (optional)index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)timeout - Max milliseconds to wait for the nth email if not already present (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<Email> waitForNthEmailWithHttpInfo(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly) throws ApiException
inboxId - Id of the inbox you are fetching emails from (optional)index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)timeout - Max milliseconds to wait for the nth email if not already present (optional)unreadOnly - Optional filter for unread only (optional, default to false)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call waitForNthEmailAsync(UUID inboxId, Integer index, Long timeout, Boolean unreadOnly, ApiCallback<Email> _callback) throws ApiException
inboxId - Id of the inbox you are fetching emails from (optional)index - Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional, default to 0)timeout - Max milliseconds to wait for the nth email if not already present (optional)unreadOnly - Optional filter for unread only (optional, default to false)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
Copyright © 2021. All rights reserved.