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
FelderVon 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
KonstruktorenKonstruktorBeschreibungAbstractWebhooksResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider) -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungabstract WRARcreate(@NotNull WebhookRequest webhookRequest) Create a webhook.abstract VARDelete a webhook.protected org.apache.http.client.methods.HttpUriRequestgetCreateHttpUriRequest(@NotNull WebhookRequest webhookRequest) protected org.apache.http.client.methods.HttpUriRequestgetDeleteHttpUriRequest(@NotNull String webhookId) protected org.apache.http.client.methods.HttpUriRequestgetListHttpUriRequest(@NotNull Map<Filter, String> filters, @Nullable Pagination pagination) abstract WRPARlist()List all webhooks.abstract WRPARList all webhooks.abstract WRPARlist(@NotNull Map<Filter, String> filters, @Nullable Pagination pagination) List all webhooks.booleanVerify webhook signatureVon Klasse geerbte Methoden com.cloudconvert.resource.AbstractResource
getHttpEntity, getHttpEntity, getHttpUriRequest, getHttpUriRequest, getJson, getSyncUri, getSyncUri, getUri, getUri, requestToMap
-
Felddetails
-
HMAC_SHA256
- Siehe auch:
-
PATH_SEGMENT_WEBHOOKS
- Siehe auch:
-
-
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:
IOExceptionURISyntaxExceptionCloudConvertClientExceptionCloudConvertServerException
-
getCreateHttpUriRequest
protected org.apache.http.client.methods.HttpUriRequest getCreateHttpUriRequest(@NotNull @NotNull WebhookRequest webhookRequest) throws IOException, URISyntaxException - Löst aus:
IOExceptionURISyntaxException
-
list
public abstract WRPAR list() throws IOException, URISyntaxException, CloudConvertClientException, CloudConvertServerExceptionList all webhooks. Requires the webhook.read scope.- Gibt zurück:
AbstractWebhooksResource- Löst aus:
IOExceptionURISyntaxExceptionCloudConvertClientExceptionCloudConvertServerException
-
list
public abstract WRPAR list(@NotNull @NotNull Map<Filter, String> filters) throws IOException, URISyntaxException, CloudConvertClientException, CloudConvertServerExceptionList 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:
IOExceptionURISyntaxExceptionCloudConvertClientExceptionCloudConvertServerException
-
list
public abstract WRPAR list(@NotNull @NotNull Map<Filter, String> filters, @Nullable @Nullable Pagination pagination) throws IOException, URISyntaxException, CloudConvertClientException, CloudConvertServerExceptionList 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:
IOExceptionURISyntaxExceptionCloudConvertClientExceptionCloudConvertServerException
-
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:
IOExceptionURISyntaxExceptionCloudConvertClientExceptionCloudConvertServerException
-
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- payloadsignature- signature- Gibt zurück:
- Löst aus:
InvalidKeyExceptionNoSuchAlgorithmException
-