Struct twitch_api2::helix::webhooks::hub::WebhookHubBody

#[non_exhaustive]pub struct WebhookHubBody<T: Topic> {
    pub callback: String,
    pub mode: WebhookSubscriptionMode,
    pub topic: T,
    pub lease_seconds: u32,
    pub secret: Option<String>,
}

This is supported on crate feature helix only.

Body Parameters for Subscribe to/Unsubscribe From Events

subscribe-tounsubscribe-from-events

Notes

This body is quite different from the official body. If you want the true representation in text, see helix::RequestPost::body on WebhookHubRequest<T: Topic>

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct {{ .. }} syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

callback: String

URL where notifications will be delivered.

mode: WebhookSubscriptionMode

Type of request. Valid values: subscribe, unsubscribe

topic: T

URL for the topic to subscribe to or unsubscribe from. topic maps to a new Twitch API endpoint.

lease_seconds: u32

Number of seconds until the subscription expires. Default: 0. Maximum: 864000.

secret: Option<String>

Secret used to sign notification payloads

Implementations

impl<T: Topic> WebhookHubBody<T>

pub fn builder() -> WebhookHubBodyBuilder<((), (), (), (), ()), T>

Create a builder for building WebhookHubBody. On the builder, call .callback(...), .mode(...), .topic(...), .lease_seconds(...), .secret(...) to set the values of the fields. Finally, call .build() to create the instance of WebhookHubBody.

Trait Implementations

impl<T: Clone + Topic> Clone for WebhookHubBody<T>

fn clone(&self) -> WebhookHubBody<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Topic> Debug for WebhookHubBody<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: Topic> Deserialize<'de> for WebhookHubBody<T> where
    T: Topic, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + Topic> PartialEq<WebhookHubBody<T>> for WebhookHubBody<T>

fn eq(&self, other: &WebhookHubBody<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WebhookHubBody<T>) -> bool

This method tests for !=.

impl<T: Topic> Serialize for WebhookHubBody<T> where
    T: Topic, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: Topic> StructuralPartialEq for WebhookHubBody<T>