Klasse AbstractWebhooksResource<WRAR extends AbstractResult<WebhookResponse>,WRPAR extends AbstractResult<Pageable<WebhookResponse>>,VAR extends AbstractResult<Void>>

java.lang.Object

com.cloudconvert.resource.AbstractResource

com.cloudconvert.resource.AbstractWebhooksResource<WRAR,WRPAR,VAR>

Alle implementierten Schnittstellen:

Closeable, AutoCloseable

Bekannte direkte Unterklassen:

AsyncWebhookResource, WebhookResource

public abstract class AbstractWebhooksResource<WRAR extends AbstractResult<WebhookResponse>,WRPAR extends AbstractResult<Pageable<WebhookResponse>>,VAR extends AbstractResult<Void>>
extends AbstractResource

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	HMAC_SHA256
static final String	PATH_SEGMENT_WEBHOOKS

Von Klasse geerbte Felder com.cloudconvert.resource.AbstractResource

BEARER, HEADER_AUTHORIZATION, HEADER_USER_AGENT, INPUT_STREAM_TYPE_REFERENCE, JOB_RESPONSE_PAGEABLE_TYPE_REFERENCE, JOB_RESPONSE_TYPE_REFERENCE, MAP_STRING_TO_OBJECT_TYPE_REFERENCE, OPERATION_RESPONSE_PAGEABLE_TYPE_REFERENCE, TASK_RESPONSE_PAGEABLE_TYPE_REFERENCE, TASK_RESPONSE_TYPE_REFERENCE, USER_RESPONSE_TYPE_REFERENCE, V2, VALUE_USER_AGENT, VOID_TYPE_REFERENCE, WEBHOOKS_RESPONSE_PAGEABLE_TYPE_REFERENCE, WEBHOOKS_RESPONSE_TYPE_REFERENCE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractWebhooksResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
abstract WRAR	create(@NotNull WebhookRequest webhookRequest)	Create a webhook.
abstract VAR	delete(@NotNull String webhookId)	Delete a webhook.
protected org.apache.http.client.methods.HttpUriRequest	getCreateHttpUriRequest(@NotNull WebhookRequest webhookRequest)
protected org.apache.http.client.methods.HttpUriRequest	getDeleteHttpUriRequest(@NotNull String webhookId)
protected org.apache.http.client.methods.HttpUriRequest	getListHttpUriRequest(@NotNull Map<Filter,String> filters, @Nullable Pagination pagination)
abstract WRPAR	list()	List all webhooks.
abstract WRPAR	list(@NotNull Map<Filter,String> filters)	List all webhooks.
abstract WRPAR	list(@NotNull Map<Filter,String> filters, @Nullable Pagination pagination)	List all webhooks.
boolean	verify(@NotNull String payload, @NotNull String signature)	Verify webhook signature

Von Klasse geerbte Methoden com.cloudconvert.resource.AbstractResource

getHttpEntity, getHttpEntity, getHttpUriRequest, getHttpUriRequest, getJson, getSyncUri, getSyncUri, getUri, getUri, requestToMap

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden java.io.Closeable

close

Felddetails

HMAC_SHA256

public static final String HMAC_SHA256

Siehe auch:

• Konstantenfeldwerte

PATH_SEGMENT_WEBHOOKS

public static final String PATH_SEGMENT_WEBHOOKS

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

AbstractWebhooksResource

public AbstractWebhooksResource(SettingsProvider settingsProvider,
 ObjectMapperProvider objectMapperProvider)

Methodendetails

create

public abstract WRAR create(@NotNull
 @NotNull WebhookRequest webhookRequest)
                     throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Create a webhook. Requires the webhook.write scope.

Parameter:

webhookRequest - WebhookRequest

Gibt zurück:

AbstractWebhooksResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getCreateHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getCreateHttpUriRequest(@NotNull
 @NotNull WebhookRequest webhookRequest)
                                                                         throws IOException,
URISyntaxException

Löst aus:

IOException

URISyntaxException

list

public abstract WRPAR list()
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all webhooks. Requires the webhook.read scope.

Gibt zurück:

AbstractWebhooksResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

public abstract WRPAR list(@NotNull
 @NotNull Map<Filter,String> filters)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all webhooks. Requires the webhook.read scope.

Parameter:

filters - (optional) Filters: - url - The result will be filtered to include only webhooks with a specific URL.

Gibt zurück:

AbstractWebhooksResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

public abstract WRPAR list(@NotNull
 @NotNull Map<Filter,String> filters,
 @Nullable
 @Nullable Pagination pagination)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

List all webhooks. Requires the webhook.read scope.

Parameter:

filters - (optional) Filters: - url - The result will be filtered to include only webhooks with a specific URL.

pagination - (optional) Pagination: - per_page - Number of tasks per page, defaults to 100. - page - The result page to show.

Gibt zurück:

AbstractWebhooksResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getListHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getListHttpUriRequest(@NotNull
 @NotNull Map<Filter,String> filters,
 @Nullable
 @Nullable Pagination pagination)
                                                                       throws URISyntaxException

Löst aus:

URISyntaxException

delete

public abstract VAR delete(@NotNull
 @NotNull String webhookId)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Delete a webhook. Requires the webhook.write scope.

Parameter:

webhookId - webhook id

Gibt zurück:

VR

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

getDeleteHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest getDeleteHttpUriRequest(@NotNull
 @NotNull String webhookId)
                                                                         throws URISyntaxException

Löst aus:

URISyntaxException

verify

public boolean verify(@NotNull
 @NotNull String payload,
 @NotNull
 @NotNull String signature)
               throws InvalidKeyException,
NoSuchAlgorithmException

Verify webhook signature

Parameter:

payload - payload

signature - signature

Gibt zurück:

Löst aus:

InvalidKeyException

NoSuchAlgorithmException