Clients -
websub :
SubscriptionClient
The HTTP based client for WebSub subscription and unsubscription.
Constructor
__init
(string url, ClientConfiguration? config)
- url string
-
The URL to change subscription at
- config ClientConfiguration? ()
-
The
http:ClientConfiguration
for 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.
Parameters
- subscriptionRequest SubscriptionChangeRequest
-
The
SubscriptionChangeRequest
containing subscription details
-
Return Type
(SubscriptionChangeResponse | error) SubscriptionChangeResponse
indicating subscription details, if the request was successful elseerror
if an error occurred with the subscription request
unsubscribe
(SubscriptionChangeRequest unsubscriptionRequest)
returns SubscriptionChangeResponse | errorSends an unsubscription request to a WebSub Hub.
Parameters
- unsubscriptionRequest SubscriptionChangeRequest
-
The
SubscriptionChangeRequest
containing unsubscription details
-
Return Type
(SubscriptionChangeResponse | error) SubscriptionChangeResponse
indicating unsubscription details, if the request was successful elseerror
if an error occurred with the unsubscription request