This API documentation is for Ballerina 1.2.0. View API documentation for the latest release.

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

Remote Methods

subscribe

Sends a subscription request to a WebSub Hub.

unsubscribe

Sends an unsubscription request to a WebSub Hub.

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