org.apache.streams.twitter.api

Interface AccountActivity

All Known Implementing Classes:

Twitter

@Remoteable(path="https://api.twitter.com/1.1/account_activity")
public interface AccountActivity

Interface for /account_activity methods.

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/overview

Method Summary

Modifier and Type	Method and Description
Boolean	deleteWebhook(Long webhookId) Removes the webhook from the provided application’s configuration.
Boolean	deleteWebhookSubscriptions(Long webhookId) Deactivates subscription for the provided user context and app.
List<Webhook>	getWebhooks() Returns all URLs and their statuses for the given app.
Boolean	getWebhookSubscription(Long webhookId) Provides a way to determine if a webhook configuration is subscribed to the provided user’s Direct Messages.
Boolean	putWebhook(Long webhookId) Triggers the challenge response check (CRC) for the given webhook’s URL.
Webhook	registerWebhook(String url) Registers a new webhook URL for the given application context.
Boolean	registerWebhookSubscriptions(Long webhookId) Subscribes the provided app to events for the provided user context.

Method Detail

getWebhooks

@RemoteMethod(httpMethod="GET",
              path="/webhooks.json")
List<Webhook> getWebhooks()

Returns all URLs and their statuses for the given app. Currently, only one webhook URL can be registered to an application. We mark a URL as invalid if it fails the daily validation check. In order to re-enable the URL, call the update endpoint.

Returns:

List\

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/get-webhook-config

registerWebhook

@RemoteMethod(httpMethod="POST",
              path="/webhooks.json")
Webhook registerWebhook(@Query(value="url")
                                                                                              String url)

Registers a new webhook URL for the given application context. The URL will be validated via CRC request before saving. In case the validation fails, a comprehensive error is returned. message to the requester. Only one webhook URL can be registered to an application.

Returns:

Webhook

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/new-webhook-config

deleteWebhook

@RemoteMethod(httpMethod="DELETE",
              path="/webhooks/{webhookId}.json")
Boolean deleteWebhook(@Path(value="webhookId")
                                                                                                          Long webhookId)

Removes the webhook from the provided application’s configuration. The webhook ID can be accessed by making a call to GET /1.1/account_activity/webhooks.

Returns:

Boolean

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/delete-webhook-config

putWebhook

@RemoteMethod(httpMethod="PUT",
              path="/webhooks/{webhookId}.json")
Boolean putWebhook(@Path(value="webhookId")
                                                                                                    Long webhookId)

Triggers the challenge response check (CRC) for the given webhook’s URL. If the check is successful, returns 204 and reenables the webhook by setting its status to valid.

Parameters:

webhookId - Webhook ID. Defined in resource path.

Returns:

Boolean

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/validate-webhook-config

getWebhookSubscription

@RemoteMethod(httpMethod="GET",
              path="/webhooks/{webhookId}/subscriptions.json")
Boolean getWebhookSubscription(@Path(value="webhookId")
                                                                                                                              Long webhookId)
                                                                                                                       throws InvocationTargetException,
                                                                                                                              org.apache.juneau.rest.client.RestCallException

Provides a way to determine if a webhook configuration is subscribed to the provided user’s Direct Messages. If the provided user context has an active subscription with the provided app, returns 204 OK. If the response code is not 204, then the user does not have an active subscription. See HTTP Response code and error messages below for details.

Parameters:

webhookId - Webhook ID. Defined in resource path.

Returns:

Boolean

Throws:

InvocationTargetException

org.apache.juneau.rest.client.RestCallException

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/get-subscription

registerWebhookSubscriptions

@RemoteMethod(httpMethod="POST",
              path="/webhooks/{webhookId}/subscriptions.json")
Boolean registerWebhookSubscriptions(@Path(value="webhookId")
                                                                                                                                     Long webhookId)
                                                                                                                              throws InvocationTargetException,
                                                                                                                                     org.apache.juneau.rest.client.RestCallException

Subscribes the provided app to events for the provided user context. When subscribed, all DM events for the provided user will be sent to the app’s webhook via POST request.

Parameters:

webhookId - Webhook ID. Defined in resource path.

Returns:

Boolean

Throws:

InvocationTargetException

org.apache.juneau.rest.client.RestCallException

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/new-subscription

deleteWebhookSubscriptions

@RemoteMethod(httpMethod="DELETE",
              path="/webhooks/{webhookId}/subscriptions.json")
Boolean deleteWebhookSubscriptions(@Path(value="webhookId")
                                                                                                                                     Long webhookId)
                                                                                                                              throws InvocationTargetException,
                                                                                                                                     org.apache.juneau.rest.client.RestCallException

Deactivates subscription for the provided user context and app. After deactivation, all DM events for the requesting user will no longer be sent to the webhook URL.

Parameters:

webhookId - Webhook ID. Defined in resource path.

Returns:

Boolean

Throws:

InvocationTargetException

org.apache.juneau.rest.client.RestCallException

See Also:

https://developer.twitter.com/en/docs/accounts-and-users/subscribe-account-activity/api-reference/delete-subscription