Trait twitch_api2::helix::Request

pub trait Request: Serialize {
    type Response: DeserializeOwned + PartialEq;

    const PATH: &'static str;
    const SCOPE: &'static [Scope];
    const OPT_SCOPE: &'static [Scope];
    fn query(&self) -> Result<String, Error> { ... }
    fn get_uri(&self) -> Result<Uri, InvalidUri> { ... }
    fn get_bare_uri() -> Result<Uri, InvalidUri> { ... }
}

This is supported on crate feature helix only.

A request is a Twitch endpoint, see New Twitch API reference

Associated Types

type Response: DeserializeOwned + PartialEq

Response type. twitch's response will deserialize to this.

Loading content...

Associated Constants

const PATH: &'static str

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope]

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope]

Optional scopes needed by this endpoint

Loading content...

Provided methods

fn query(&self) -> Result<String, Error>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

Loading content...

Implementors

impl Request for GetBitsLeaderboardRequest

type Response = BitsLeaderboard

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetCheermotesRequest

type Response = Vec<Cheermote>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetChannelEditorsRequest

type Response = Vec<Editor>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetChannelInformationRequest

type Response = Option<ChannelInformation>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for ModifyChannelInformationRequest

type Response = ModifyChannelInformation

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for StartCommercialRequest

type Response = Vec<StartCommercial>

FIXME: Make non-vec

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetClipsRequest

type Response = Vec<Clip>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for DeleteEventSubSubscriptionRequest

This is supported on crate feature eventsub only.

type Response = DeleteEventSubSubscription

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetEventSubSubscriptionsRequest

This is supported on crate feature eventsub only.

type Response = Vec<EventSubSubscription>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetGamesRequest

type Response = Vec<Game>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetTopGamesRequest

type Response = Vec<Game>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetHypeTrainEventsRequest

type Response = Vec<HypeTrainEvent>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for CheckAutoModStatusRequest

type Response = Vec<CheckAutoModStatus>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetBannedEventsRequest

type Response = Vec<BannedEvent>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetBannedUsersRequest

type Response = Vec<BannedUser>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetModeratorEventsRequest

type Response = Vec<ModeratorEvent>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetModeratorsRequest

type Response = Vec<Moderator>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetCustomRewardRedemptionRequest

type Response = Vec<CustomRewardRedemption>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for UpdateRedemptionStatusRequest

type Response = UpdateRedemptionStatusInformation

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for SearchCategoriesRequest

type Response = Vec<Category>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for SearchChannelsRequest

type Response = Vec<Channel>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetStreamTagsRequest

type Response = Vec<Tag>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetStreamsRequest

type Response = Vec<Stream>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetBroadcasterSubscriptionsEventsRequest

type Response = Vec<BroadcasterSubscriptionEvent>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetBroadcasterSubscriptionsRequest

type Response = Vec<BroadcasterSubscription>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetAllStreamTagsRequest

type Response = Vec<Tag>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for BlockUserRequest

type Response = BlockUser

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for CreateUserFollowsRequest

type Response = CreateUserFollows

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for DeleteUserFollowsRequest

type Response = DeleteUserFollow

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetUserBlockListRequest

type Response = Vec<UserBlock>

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetUsersFollowsRequest

type Response = Vec<UsersFollow>

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetUsersRequest

type Response = Vec<User>

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for UnblockUserRequest

type Response = UnblockUser

const OPT_SCOPE: &'static [Scope]

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for DeleteVideosRequest

type Response = DeleteVideo

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetVideosRequest

type Response = Vec<Video>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl Request for GetWebhookSubscriptionsRequest

type Response = Vec<WebhookSubscription>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl<E: EventSubscription> Request for CreateEventSubSubscriptionRequest<E>

This is supported on crate feature eventsub only.

type Response = CreateEventSubSubscription<E>

const PATH: &'static str

const SCOPE: &'static [Scope]

impl<T: Topic> Request for WebhookHubRequest<T>

type Response = WebhookHub

const PATH: &'static str

const SCOPE: &'static [Scope]

Loading content...