Skip to main content

EventsApi

Struct EventsApi 

Source
pub struct EventsApi<'a> { /* private fields */ }
Expand description

Events API - handles webhook/event subscription endpoints

Scopes required: events:subscribe

Implementations§

Source§

impl<'a> EventsApi<'a>

Source

pub async fn list( &self, broadcaster_user_id: Option<u64>, ) -> Result<Vec<EventSubscription>>

List active event subscriptions

Optionally filter by broadcaster user ID.

Requires OAuth token with events:subscribe scope

§Example
// List all subscriptions
let subs = client.events().list(None).await?;

// List subscriptions for a specific broadcaster
let subs = client.events().list(Some(12345)).await?;
Source

pub async fn subscribe( &self, request: SubscribeRequest, ) -> Result<Vec<SubscribeResult>>

Subscribe to events

Requires OAuth token with events:subscribe scope

§Example
use kick_api::{SubscribeRequest, SubscribeEvent};

let request = SubscribeRequest {
    broadcaster_user_id: Some(12345),
    method: "webhook".to_string(),
    events: vec![
        SubscribeEvent { name: "chat.message.created".to_string(), version: 1 },
    ],
};
let results = client.events().subscribe(request).await?;
Source

pub async fn unsubscribe(&self, ids: Vec<String>) -> Result<()>

Unsubscribe from events by subscription IDs

Requires OAuth token with events:subscribe scope

§Example
client.events().unsubscribe(vec!["sub_id_1".to_string(), "sub_id_2".to_string()]).await?;

Auto Trait Implementations§

§

impl<'a> Freeze for EventsApi<'a>

§

impl<'a> !RefUnwindSafe for EventsApi<'a>

§

impl<'a> Send for EventsApi<'a>

§

impl<'a> Sync for EventsApi<'a>

§

impl<'a> Unpin for EventsApi<'a>

§

impl<'a> !UnwindSafe for EventsApi<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more