Package com.github.twitch4j.helix.webhooks.domain

Class WebhookRequest

java.lang.Object
com.github.twitch4j.helix.webhooks.domain.WebhookRequest
public class WebhookRequest
extends java.lang.Object

  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.lang.String MODE_SUBSCRIBE  
    static java.lang.String MODE_UNSUBSCRIBE  

  • Constructor Summary

    Constructors
    Constructor Description
    WebhookRequest​(@NonNull java.lang.String callback, @NonNull java.lang.String mode, @NonNull TwitchWebhookTopic topic, java.lang.Integer leaseSeconds, java.lang.String secret)  
    WebhookRequest​(@NonNull java.lang.String callback, @NonNull java.lang.String mode, @NonNull java.lang.String topic, java.lang.Integer leaseSeconds, java.lang.String secret)  

  • Method Summary

    Modifier and Type Method Description
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    @NonNull java.lang.String getCallback()
    Callback URL
    java.lang.Integer getLeaseSeconds()
    Lease time in seconds.
    @NonNull java.lang.String getMode()
    Either "subscribe" or "unsubscribe"
    java.lang.String getSecret()
    Secret used to sign notification payloads.
    @NonNull java.lang.String getTopic()
    Topic URL Can be generated by TwitchWebhookTopic.toString()
    int hashCode()  
    void setCallback​(@NonNull java.lang.String callback)
    Callback URL
    void setLeaseSeconds​(java.lang.Integer leaseSeconds)
    Lease time in seconds.
    void setMode​(@NonNull java.lang.String mode)
    Either "subscribe" or "unsubscribe"
    void setSecret​(java.lang.String secret)
    Secret used to sign notification payloads.
    void setTopic​(@NonNull java.lang.String topic)
    Topic URL Can be generated by TwitchWebhookTopic.toString()
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • WebhookRequest

      public WebhookRequest​(@NonNull @NonNull java.lang.String callback, @NonNull @NonNull java.lang.String mode, @NonNull @NonNull TwitchWebhookTopic topic, java.lang.Integer leaseSeconds, java.lang.String secret)

    • WebhookRequest

      public WebhookRequest​(@NonNull @NonNull java.lang.String callback, @NonNull @NonNull java.lang.String mode, @NonNull @NonNull java.lang.String topic, java.lang.Integer leaseSeconds, java.lang.String secret)

  • Method Details

    • getCallback

      @NonNull public @NonNull java.lang.String getCallback()
      Callback URL

    • getMode

      @NonNull public @NonNull java.lang.String getMode()
      Either "subscribe" or "unsubscribe"

    • getTopic

      @NonNull public @NonNull java.lang.String getTopic()
      Topic URL Can be generated by TwitchWebhookTopic.toString()

    • getLeaseSeconds

      public java.lang.Integer getLeaseSeconds()
      Lease time in seconds. Default is 0, which is only useful for testing.

    • getSecret

      public java.lang.String getSecret()
      Secret used to sign notification payloads. The X-Hub-Signature header is generated by sha256(secret, notification_bytes). We strongly encourage you to use this, so your application can verify that notifications are genuine.

    • setCallback

      public void setCallback​(@NonNull @NonNull java.lang.String callback)
      Callback URL

    • setMode

      public void setMode​(@NonNull @NonNull java.lang.String mode)
      Either "subscribe" or "unsubscribe"

    • setTopic

      public void setTopic​(@NonNull @NonNull java.lang.String topic)
      Topic URL Can be generated by TwitchWebhookTopic.toString()

    • setLeaseSeconds

      public void setLeaseSeconds​(java.lang.Integer leaseSeconds)
      Lease time in seconds. Default is 0, which is only useful for testing.

    • setSecret

      public void setSecret​(java.lang.String secret)
      Secret used to sign notification payloads. The X-Hub-Signature header is generated by sha256(secret, notification_bytes). We strongly encourage you to use this, so your application can verify that notifications are genuine.

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • canEqual

      protected boolean canEqual​(java.lang.Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object