Trait twitch_api2::helix::Request [−][src]
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
[src]
Response type. twitch’s response will deserialize to this.
Associated Constants
const PATH: &'static str
[src]
The path to the endpoint relative to the helix root. eg. channels
for Get Channel Information
const SCOPE: &'static [Scope]
[src]
Scopes needed by this endpoint
const OPT_SCOPE: &'static [Scope]
[src]
Optional scopes needed by this endpoint
Provided methods
fn query(&self) -> Result<String, Error>
[src]
Defines layout of the url parameters.
fn get_uri(&self) -> Result<Uri, InvalidUri>
[src]
Returns full URI for the request, including query parameters.
fn get_bare_uri() -> Result<Uri, InvalidUri>
[src]
Returns bare URI for the request, NOT including query parameters.
Implementors
impl Request for GetBitsLeaderboardRequest
[src]
impl Request for GetBitsLeaderboardRequest
[src]impl Request for GetCheermotesRequest
[src]
impl Request for GetCheermotesRequest
[src]impl Request for GetChannelEditorsRequest
[src]
impl Request for GetChannelEditorsRequest
[src]impl Request for GetChannelInformationRequest
[src]
impl Request for GetChannelInformationRequest
[src]impl Request for ModifyChannelInformationRequest
[src]
impl Request for ModifyChannelInformationRequest
[src]type Response = ModifyChannelInformation
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for StartCommercialRequest
[src]
impl Request for StartCommercialRequest
[src]impl Request for GetClipsRequest
[src]
impl Request for GetClipsRequest
[src]impl Request for DeleteEventSubSubscriptionRequest
[src]
impl Request for DeleteEventSubSubscriptionRequest
[src]This is supported on crate feature
eventsub
only.type Response = DeleteEventSubSubscription
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for GetEventSubSubscriptionsRequest
[src]
impl Request for GetEventSubSubscriptionsRequest
[src]This is supported on crate feature
eventsub
only.type Response = EventSubSubscriptions
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for GetGamesRequest
[src]
impl Request for GetGamesRequest
[src]impl Request for GetTopGamesRequest
[src]
impl Request for GetTopGamesRequest
[src]impl Request for GetHypeTrainEventsRequest
[src]
impl Request for GetHypeTrainEventsRequest
[src]impl Request for CheckAutoModStatusRequest
[src]
impl Request for CheckAutoModStatusRequest
[src]impl Request for GetBannedEventsRequest
[src]
impl Request for GetBannedEventsRequest
[src]impl Request for GetBannedUsersRequest
[src]
impl Request for GetBannedUsersRequest
[src]impl Request for GetModeratorEventsRequest
[src]
impl Request for GetModeratorEventsRequest
[src]impl Request for GetModeratorsRequest
[src]
impl Request for GetModeratorsRequest
[src]impl Request for CreateCustomRewardRequest
[src]
impl Request for CreateCustomRewardRequest
[src]type Response = CreateCustomRewardResponse
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for DeleteCustomRewardRequest
[src]
impl Request for DeleteCustomRewardRequest
[src]impl Request for GetCustomRewardRequest
[src]
impl Request for GetCustomRewardRequest
[src]impl Request for UpdateRedemptionStatusRequest
[src]
impl Request for UpdateRedemptionStatusRequest
[src]type Response = UpdateRedemptionStatusInformation
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for SearchCategoriesRequest
[src]
impl Request for SearchCategoriesRequest
[src]impl Request for SearchChannelsRequest
[src]
impl Request for SearchChannelsRequest
[src]impl Request for GetFollowedStreamsRequest
[src]
impl Request for GetFollowedStreamsRequest
[src]impl Request for GetStreamTagsRequest
[src]
impl Request for GetStreamTagsRequest
[src]impl Request for GetStreamsRequest
[src]
impl Request for GetStreamsRequest
[src]impl Request for ReplaceStreamTagsRequest
[src]
impl Request for ReplaceStreamTagsRequest
[src]impl Request for CheckUserSubscriptionRequest
[src]
impl Request for CheckUserSubscriptionRequest
[src]impl Request for GetAllStreamTagsRequest
[src]
impl Request for GetAllStreamTagsRequest
[src]impl Request for GetChannelTeamsRequest
[src]
impl Request for GetChannelTeamsRequest
[src]impl Request for GetTeamsRequest
[src]
impl Request for GetTeamsRequest
[src]impl Request for BlockUserRequest
[src]
impl Request for BlockUserRequest
[src]impl Request for CreateUserFollowsRequest
[src]
impl Request for CreateUserFollowsRequest
[src]type Response = CreateUserFollows
const OPT_SCOPE: &'static [Scope]
[src]
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for DeleteUserFollowsRequest
[src]
impl Request for DeleteUserFollowsRequest
[src]type Response = DeleteUserFollow
const OPT_SCOPE: &'static [Scope]
[src]
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for GetUserBlockListRequest
[src]
impl Request for GetUserBlockListRequest
[src]impl Request for GetUsersFollowsRequest
[src]
impl Request for GetUsersFollowsRequest
[src]type Response = UsersFollows
const OPT_SCOPE: &'static [Scope]
[src]
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for GetUsersRequest
[src]
impl Request for GetUsersRequest
[src]impl Request for UnblockUserRequest
[src]
impl Request for UnblockUserRequest
[src]type Response = UnblockUser
const OPT_SCOPE: &'static [Scope]
[src]
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl Request for DeleteVideosRequest
[src]
impl Request for DeleteVideosRequest
[src]impl Request for GetVideosRequest
[src]
impl Request for GetVideosRequest
[src]impl<E: EventSubscription> Request for CreateEventSubSubscriptionRequest<E>
[src]
impl<E: EventSubscription> Request for CreateEventSubSubscriptionRequest<E>
[src]This is supported on crate feature
eventsub
only.type Response = CreateEventSubSubscription<E>
const PATH: &'static str
[src]
const SCOPE: &'static [Scope]
[src]
impl<T: Topic> Request for WebhookHubRequest<T>
[src]
impl<T: Topic> Request for WebhookHubRequest<T>
[src]