Clients - websub : SubscriptionClient

The HTTP based client for WebSub subscription and unsubscription.

Constructor

__init

(string url, ClientConfiguration? config)

  • url string
  • The URL at which the subscription should be changed

  • config ClientConfiguration? <ballerina/http:ClientConfiguration?> ()
  • The http:ClientConfiguration for the underlying client or ()

Remote Methods

subscribe Sends a subscription request to a WebSub Hub.
 websub:SubscriptionChangeResponse|error response = websubHubClientEP->subscribe(subscriptionRequest);
unsubscribe Sends an unsubscription request to a WebSub Hub.
 websub:SubscriptionChangeResponse|error response = websubHubClientEP->unsubscribe(subscriptionRequest);

subscribe

(SubscriptionChangeRequest subscriptionRequest)

returns SubscriptionChangeResponse | error
Sends a subscription request to a WebSub Hub.
 websub:SubscriptionChangeResponse|error response = websubHubClientEP->subscribe(subscriptionRequest);

Parameters

  • Return Type

    (SubscriptionChangeResponse | error)
  • The SubscriptionChangeResponse indicating subscription details if the request was successful or else an error if an error occurred with the subscription request

unsubscribe

(SubscriptionChangeRequest unsubscriptionRequest)

returns SubscriptionChangeResponse | error
Sends an unsubscription request to a WebSub Hub.
 websub:SubscriptionChangeResponse|error response = websubHubClientEP->unsubscribe(subscriptionRequest);

Parameters

  • Return Type

    (SubscriptionChangeResponse | error)
  • An unsubscription details if the request was successful or else an error if an error occurred with the unsubscription request