Trait twitch_api2::eventsub::EventSubscription

pub trait EventSubscription: DeserializeOwned + Serialize + PartialEq + Clone {
    type Payload: PartialEq + Debug + DeserializeOwned + Serialize + Clone;

    const SCOPE: &'static [Scope];
    const VERSION: &'static str;
    const EVENT_TYPE: EventType;
    const OPT_SCOPE: &'static [Scope] = &[];

    fn condition(&self) -> Result<Value, Error> { ... }
}

Available on crate feature eventsub only.

An EventSub subscription.

Required Associated Types

type Payload: PartialEq + Debug + DeserializeOwned + Serialize + Clone

Payload for given subscription

Required Associated Constants

const SCOPE: &'static [Scope]

Available on crate feature twitch_oauth2 only.

Scopes needed by this subscription

const VERSION: &'static str

Subscription type version

const EVENT_TYPE: EventType

Subscription type name.

Provided Associated Constants

const OPT_SCOPE: &'static [Scope] = &[]

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this subscription

Provided Methods

fn condition(&self) -> Result<Value, Error>

Creates the condition for this EventSub subscription

Implementors

impl EventSubscription for ChannelBanV1

type Payload = ChannelBanV1Payload

const EVENT_TYPE: EventType = EventType::ChannelBan

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelModerate]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelCheerV1

type Payload = ChannelCheerV1Payload

const EVENT_TYPE: EventType = EventType::ChannelCheer

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::BitsRead]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelFollowV1

type Payload = ChannelFollowV1Payload

const EVENT_TYPE: EventType = EventType::ChannelFollow

const SCOPE: &'static [Scope] = &[]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelGoalBeginV1

type Payload = ChannelGoalBeginV1Payload

const EVENT_TYPE: EventType = EventType::ChannelGoalBegin

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadGoals]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelGoalEndV1

type Payload = ChannelGoalEndV1Payload

const EVENT_TYPE: EventType = EventType::ChannelGoalEnd

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadGoals]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelGoalProgressV1

type Payload = ChannelGoalProgressV1Payload

const EVENT_TYPE: EventType = EventType::ChannelGoalProgress

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadGoals]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelHypeTrainBeginV1

type Payload = ChannelHypeTrainBeginV1Payload

const EVENT_TYPE: EventType = EventType::ChannelHypeTrainBegin

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadHypeTrain]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelHypeTrainEndV1

type Payload = ChannelHypeTrainEndV1Payload

const EVENT_TYPE: EventType = EventType::ChannelHypeTrainEnd

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadHypeTrain]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelHypeTrainProgressV1

type Payload = ChannelHypeTrainProgressV1Payload

const EVENT_TYPE: EventType = EventType::ChannelHypeTrainProgress

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadHypeTrain]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPointsCustomRewardAddV1

type Payload = ChannelPointsCustomRewardAddV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPointsCustomRewardAdd

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadRedemptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPointsCustomRewardRedemptionAddV1

type Payload = ChannelPointsCustomRewardRedemptionAddV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPointsCustomRewardRedemptionAdd

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadRedemptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPointsCustomRewardRedemptionUpdateV1

type Payload = ChannelPointsCustomRewardRedemptionUpdateV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPointsCustomRewardRedemptionUpdate

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadRedemptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPointsCustomRewardRemoveV1

type Payload = ChannelPointsCustomRewardRemoveV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPointsCustomRewardRemove

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadRedemptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPointsCustomRewardUpdateV1

type Payload = ChannelPointsCustomRewardUpdateV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPointsCustomRewardUpdate

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadRedemptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPollBeginV1

type Payload = ChannelPollBeginV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPollBegin

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadPolls]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPollEndV1

type Payload = ChannelPollEndV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPollEnd

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadPolls]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPollProgressV1

type Payload = ChannelPollProgressV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPollProgress

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadPolls]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPredictionBeginV1

type Payload = ChannelPredictionBeginV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPredictionBegin

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadPredictions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPredictionEndV1

type Payload = ChannelPredictionEndV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPredictionEnd

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadPredictions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPredictionLockV1

type Payload = ChannelPredictionLockV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPredictionLock

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadPredictions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelPredictionProgressV1

type Payload = ChannelPredictionProgressV1Payload

const EVENT_TYPE: EventType = EventType::ChannelPredictionProgress

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadPredictions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelRaidV1

type Payload = ChannelRaidV1Payload

const EVENT_TYPE: EventType = EventType::ChannelRaid

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadSubscriptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelSubscribeV1

type Payload = ChannelSubscribeV1Payload

const EVENT_TYPE: EventType = EventType::ChannelSubscribe

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadSubscriptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelSubscriptionEndV1

type Payload = ChannelSubscriptionEndV1Payload

const EVENT_TYPE: EventType = EventType::ChannelSubscriptionEnd

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadSubscriptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelSubscriptionGiftV1

type Payload = ChannelSubscriptionGiftV1Payload

const EVENT_TYPE: EventType = EventType::ChannelSubscriptionGift

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadSubscriptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelSubscriptionMessageV1

type Payload = ChannelSubscriptionMessageV1Payload

const EVENT_TYPE: EventType = EventType::ChannelSubscriptionMessage

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelReadSubscriptions]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelUnbanV1

type Payload = ChannelUnbanV1Payload

const EVENT_TYPE: EventType = EventType::ChannelUnban

const SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::ChannelModerate]

const VERSION: &'static str = "1"

impl EventSubscription for ChannelUpdateV1

type Payload = ChannelUpdateV1Payload

const EVENT_TYPE: EventType = EventType::ChannelUpdate

const SCOPE: &'static [Scope] = &[]

const VERSION: &'static str = "1"

impl EventSubscription for StreamOfflineV1

type Payload = StreamOfflineV1Payload

const EVENT_TYPE: EventType = EventType::StreamOffline

const SCOPE: &'static [Scope] = &[]

const VERSION: &'static str = "1"

impl EventSubscription for StreamOnlineV1

type Payload = StreamOnlineV1Payload

const EVENT_TYPE: EventType = EventType::StreamOnline

const SCOPE: &'static [Scope] = &[]

const VERSION: &'static str = "1"

impl EventSubscription for UserAuthorizationGrantV1

type Payload = UserAuthorizationGrantV1Payload

const EVENT_TYPE: EventType = EventType::UserAuthorizationGrant

const SCOPE: &'static [Scope] = &[]

const VERSION: &'static str = "1"

impl EventSubscription for UserAuthorizationRevokeV1

type Payload = UserAuthorizationRevokeV1Payload

const EVENT_TYPE: EventType = EventType::UserAuthorizationRevoke

const SCOPE: &'static [Scope] = &[]

const VERSION: &'static str = "1"

impl EventSubscription for UserUpdateV1

type Payload = UserUpdateV1Payload

const EVENT_TYPE: EventType = EventType::UserUpdate

const OPT_SCOPE: &'static [Scope] = &[twitch_oauth2::Scope::UserReadEmail]

const SCOPE: &'static [Scope] = &[]

const VERSION: &'static str = "1"