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? ()
-
The
http:ClientConfigurationfor the underlying client or()
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 | errorSends a subscription request to a WebSub Hub.
websub:SubscriptionChangeResponse|error response = websubHubClientEP->subscribe(subscriptionRequest);
Parameters
- subscriptionRequest SubscriptionChangeRequest
-
The
SubscriptionChangeRequestcontaining the subscription details
-
Return Type
(SubscriptionChangeResponse | error) The
SubscriptionChangeResponseindicating subscription details if the request was successful or else anerrorif an error occurred with the subscription request
unsubscribe
(SubscriptionChangeRequest unsubscriptionRequest)
returns SubscriptionChangeResponse | errorSends an unsubscription request to a WebSub Hub.
websub:SubscriptionChangeResponse|error response = websubHubClientEP->unsubscribe(subscriptionRequest);
Parameters
- unsubscriptionRequest SubscriptionChangeRequest
-
The
SubscriptionChangeRequestcontaining unsubscription details
-
Return Type
(SubscriptionChangeResponse | error) An unsubscription details if the request was successful or else an
errorif an error occurred with the unsubscription request