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

Object - websub : IntentVerificationRequest

Object representing an intent verification request received.

Methods

Builds the response for the request, verifying intention to subscribe, if the topic matches that expected.

Builds the response for the request, verifying intention to unsubscribe, if the topic matches that expected.

Fields

  • mode string
  • The mode specified in the intent verification request, subscription or unsubscription

  • topic string
  • The topic for which intent is verified to subscribe/unsubscribe

  • challenge string
  • The challenge to be echoed to verify intent to subscribe/unsubscribe

  • leaseSeconds int (default 0)
  • The lease seconds period for which a subscription will be active if intent verification is being done for subscription

  • request Request (default Request)
  • An http:Request received for intent verification

buildSubscriptionVerificationResponse

(string expectedTopic)

returns Response

Builds the response for the request, verifying intention to subscribe, if the topic matches that expected.

  http:Response response = request.buildSubscriptionVerificationResponse("<TOPIC_TO_VERIFY_FOR>");

Parameters

  • expectedTopic string
  • The topic for which subscription should be accepted

  • Return Type

    (Response)
  • An http:Response, which to the hub verifying/denying intent to subscribe

buildUnsubscriptionVerificationResponse

(string expectedTopic)

returns Response

Builds the response for the request, verifying intention to unsubscribe, if the topic matches that expected.

 http:Response response = request.buildUnsubscriptionVerificationResponse("<TOPIC_TO_VERIFY_FOR>");

Parameters

  • expectedTopic string
  • The topic for which unsubscription should be accepted

  • Return Type

    (Response)
  • An http:Response, which to for the hub verifying/denying intent to unsubscribe