helix

package module

Go to main page

Versions in this module

v0

v0.7.0

Aug 16, 2020

Changes in this version

+ type AccessCredentials struct

+ AccessToken string

+ ExpiresIn int

+ RefreshToken string

+ Scopes []string

+ type AuthorizationURLParams struct

+ ForceVerify bool

+ ResponseType string

+ Scopes []string

+ State string

v0.6.0

Aug 6, 2020

Changes in this version

type AppAccessCredentials

+ Scopes []string

+ type Channel struct

+ DisplayName string

+ GameID string

+ ID string

+ IsLive bool

+ Language string

+ StartedAt Time

+ TagIDs []string

+ ThumbnailURL string

+ Title string

type Client

+ func (c *Client) SearchChannels(params *SearchChannelsParams) (*SearchChannelsResponse, error)

+ type ManySearchChannels struct

+ Channels []Channel

+ Pagination Pagination

+ type SearchChannelsParams struct

+ After string

+ Channel string

+ First int

+ LiveOnly bool

+ type SearchChannelsResponse struct

+ Data ManySearchChannels

v0.5.9

May 16, 2020

Changes in this version

type Client

+ func (c *Client) ValidateToken(accessToken string) (bool, *ValidateTokenResponse, error)

+ type TokenDetails struct

+ ClientID string

+ Login string

+ Scopes []string

+ UserID string

+ type ValidateTokenResponse struct

+ Data TokenDetails

v0.5.8

Mar 22, 2020

Changes in this version

+ const DefaultAPIBaseURL

type Options

+ APIBaseURL string

v0.5.7

Feb 15, 2020

Changes in this version

type Client

+ func (c *Client) UpdateUserExtensions(payload *UpdateUserExtensionsPayload) (*UserActiveExtensionsResponse, error)

type Response

+ func (r *Response) HydrateResponseCommon(rc *ResponseCommon)

+ type UpdateUserExtensionsPayload struct

+ Component map[string]UserActiveExtensionInfo

+ Overlay map[string]UserActiveExtensionInfo

+ Panel map[string]UserActiveExtensionInfo

v0.5.6

Feb 11, 2020

Changes in this version

type Client

+ func (c *Client) GetUserActiveExtensions(params *UserActiveExtensionsParams) (*UserActiveExtensionsResponse, error)

+ func (c *Client) GetUserExtensions() (*UserExtensionsResponse, error)

+ type ManyUserExtensions struct

+ UserExtensions []UserExtension

+ type UserActiveExtension struct

+ Component map[string]UserActiveExtensionInfo

+ Overlay map[string]UserActiveExtensionInfo

+ Panel map[string]UserActiveExtensionInfo

+ type UserActiveExtensionInfo struct

+ Active bool

+ ID string

+ Name string

+ Version string

+ X int

+ Y int

+ type UserActiveExtensionSet struct

+ UserActiveExtensions UserActiveExtension

+ type UserActiveExtensionsParams struct

+ UserID string

+ type UserActiveExtensionsResponse struct

+ Data UserActiveExtensionSet

+ type UserExtension struct

+ CanActivate bool

+ ID string

+ Name string

+ Type []string

+ Version string

+ type UserExtensionsResponse struct

+ Data ManyUserExtensions

v0.5.5

Jan 24, 2020

Changes in this version

+ type Ban struct

+ ExpiresAt Time

+ UserID string

+ UserName string

+ type BannedUsersParams struct

+ After string

+ Before string

+ BroadcasterID string

+ UserID string

+ type BannedUsersResponse struct

+ Data ManyBans

type Client

+ func (c *Client) GetBannedUsers(params *BannedUsersParams) (*BannedUsersResponse, error)

+ type ManyBans struct

+ Bans []Ban

+ Pagination Pagination

v0.5.4

Oct 19, 2019

Changes in this version

type Stream

+ TagIDs []string

v0.5.3

Oct 14, 2019

Changes in this version

type Client

+ func (c *Client) GetSubscriptions(params *SubscriptionsParams) (*SubscriptionsResponse, error)

+ type ManySubscriptions struct

+ Pagination Pagination

+ Subscriptions []Subscription

+ type Subscription struct

+ BroadcasterID string

+ BroadcasterName string

+ IsGift bool

+ PlanName string

+ Tier string

+ UserID string

+ UserName string

+ type SubscriptionsParams struct

+ BroadcasterID string

+ UserID []string

+ type SubscriptionsResponse struct

+ Data ManySubscriptions

v0.5.2

May 23, 2019

v0.5.1

Jan 3, 2019

v0.5.0

Dec 31, 2018

Changes in this version

type Clip

+ BroadcasterName string

+ CreatorName string

type ClipsParams

+ After string

+ Before string

+ BroadcasterID string

+ EndedAt Time

+ First int

+ GameID string

+ StartedAt Time

+ type CreateClipParams struct

+ BroadcasterID string

+ HasDelay bool

type ManyClips

+ Pagination Pagination

+ type UpdateUserParams struct

+ Description string

v0.4.2

Dec 26, 2018

Changes in this version

+ var ExtensionAnalyticsRegexp = regexp.MustCompile("helix/analytics\\?extension_id=(?P<extension_id>\\w+)>")

+ var GameAnalyticsRegexp = regexp.MustCompile("helix/analytics\\?game_id=(?P<game_id>\\w+)>")

+ var StreamChangedRegexp = regexp.MustCompile("helix/streams\\?user_id=(?P<user_id>\\d+)>")

+ var UserChangedRegexp = regexp.MustCompile("helix/users\\?id=(?P<id>\\d+)>")

+ var UserFollowsRegexp = regexp.MustCompile(...)

+ func GetWebhookTopicValuesFromRequest(req *http.Request, topic WebhookTopic) map[string]string

type Client

+ func (c *Client) CreateStreamMarker(params *CreateStreamMarkerParams) (*CreateStreamMarkerResponse, error)

+ func (c *Client) PostWebhookSubscription(payload *WebhookSubscriptionPayload) (*WebhookSubscriptionResponse, error)

+ type CreateStreamMarker struct

+ CreatedAt Time

+ Description string

+ ID string

+ PositionSeconds int

+ type CreateStreamMarkerParams struct

+ Description string

+ UserID string

+ type CreateStreamMarkerResponse struct

+ Data ManyCreateStreamMarkers

+ type ManyCreateStreamMarkers struct

+ CreateStreamMarkers []CreateStreamMarker

type StreamMetadata

+ UserName string

type UserBitTotal

+ UserName string

type UserFollow

+ FromName string

+ ToName string

type Video

+ UserName string

+ type WebhookSubscriptionPayload struct

+ Callback string

+ LeaseSeconds int

+ Mode string

+ Secret string

+ Topic string

+ type WebhookSubscriptionResponse struct

+ type WebhookTopic int

+ const ExtensionAnalyticsTopic

+ const GameAnalyticsTopic

+ const StreamChangedTopic

+ const UserChangedTopic

+ const UserFollowsTopic

+ func GetWebhookTopicFromRequest(req *http.Request) WebhookTopic

v0.4.1

Nov 30, 2018

Changes in this version

type Client

+ func (c *Client) GetStreamMarkers(params *StreamMarkersParams) (*StreamMarkersResponse, error)

+ type ManyStreamMarkers struct

+ Pagination Pagination

+ StreamMarkers []StreamMarker

+ type Marker struct

+ CreatedAt Time

+ Description string

+ ID string

+ PositionSeconds int

+ URL string

type Stream

+ UserName string

+ type StreamMarker struct

+ UserID string

+ UserName string

+ Videos []VideoMarker

+ type StreamMarkersParams struct

+ After string

+ Before string

+ First int

+ UserID string

+ VideoID string

+ type StreamMarkersResponse struct

+ Data ManyStreamMarkers

+ type VideoMarker struct

+ Markers []Marker

+ VideoID string

v0.4.0

Oct 19, 2018

Changes in this version

type Client

+ func (c *Client) GetExtensionAnalytics(params *ExtensionAnalyticsParams) (*ExtensionAnalyticsResponse, error)

+ type DateRange struct

+ EndedAt Time

+ StartedAt Time

+ type ExtensionAnalytic struct

+ DateRange DateRange

+ ExtensionID string

+ Type string

+ URL string

+ type ExtensionAnalyticsParams struct

+ After string

+ EndedAt Time

+ ExtensionID string

+ First int

+ StartedAt Time

+ Type string

+ type ExtensionAnalyticsResponse struct

+ Data ManyExtensionAnalytics

type GameAnalytic

+ DateRange DateRange

+ Type string

+ type GameAnalyticsParams struct

+ After string

+ EndedAt Time

+ First int

+ GameID string

+ StartedAt Time

+ Type string

+ type ManyExtensionAnalytics struct

+ ExtensionAnalytics []ExtensionAnalytic

+ Pagination Pagination

type ManyGameAnalytics

+ Pagination Pagination

v0.3.1

Aug 24, 2018

Changes in this version

type Client

+ func (c *Client) GetWebhookSubscriptions(params *WebhookSubscriptionsParams) (*WebhookSubscriptionsResponse, error)

+ type ManyWebhookSubscriptions struct

+ Pagination Pagination

+ Total int

+ WebhookSubscriptions []WebhookSubscription

+ type WebhookSubscription struct

+ Callback string

+ ExpiresAt Time

+ Topic string

+ type WebhookSubscriptionsParams struct

+ After string

+ First int

+ type WebhookSubscriptionsResponse struct

+ Data ManyWebhookSubscriptions

v0.3.0

Jun 16, 2018

Changes in this version

type CreateClipResponse

+ func (ccr *CreateClipResponse) GetClipsCreationRateLimit() int

+ func (ccr *CreateClipResponse) GetClipsCreationRateLimitRemaining() int

type ResponseCommon

+ Header http.Header

+ func (rc *ResponseCommon) GetRateLimit() int

+ func (rc *ResponseCommon) GetRateLimitRemaining() int

+ func (rc *ResponseCommon) GetRateLimitReset() int

type StreamsMetadataResponse

+ func (sr *StreamsMetadataResponse) GetStreamsMetadataRateLimit() int

+ func (sr *StreamsMetadataResponse) GetStreamsMetadataRateLimitRemaining() int

v0.2.0

Jun 8, 2018

v0.1.0

Apr 8, 2018

Changes in this version

+ const APIBaseURL

+ const AuthBaseURL

+ type AppAccessCredentials struct

+ AccessToken string

+ ExpiresIn int

+ type AppAccessTokenResponse struct

+ Data AppAccessCredentials

+ type BitsDateRange struct

+ EndedAt Time

+ StartedAt Time

+ type BitsLeaderboardParams struct

+ Count int

+ Period string

+ StartedAt time.Time

+ UserID string

+ type BitsLeaderboardResponse struct

+ Data ManyUserBitTotals

+ type Client struct

+ func NewClient(options *Options) (*Client, error)

+ func (c *Client) CreateClip(broadcasterID string) (*CreateClipResponse, error)

+ func (c *Client) CreateEntitlementsUploadURL(manifestID, entitlementType string) (*EntitlementsUploadResponse, error)

+ func (c *Client) GetAppAccessToken() (*AppAccessTokenResponse, error)

+ func (c *Client) GetAuthorizationURL(state string, forceVerify bool) string

+ func (c *Client) GetBitsLeaderboard(params *BitsLeaderboardParams) (*BitsLeaderboardResponse, error)

+ func (c *Client) GetClips(params *ClipsParams) (*ClipsResponse, error)

+ func (c *Client) GetGameAnalytics(gameID string) (*GameAnalyticsResponse, error)

+ func (c *Client) GetGames(params *GamesParams) (*GamesResponse, error)

+ func (c *Client) GetStreams(params *StreamsParams) (*StreamsResponse, error)

+ func (c *Client) GetStreamsMetadata(params *StreamsMetadataParams) (*StreamsMetadataResponse, error)

+ func (c *Client) GetTopGames(params *TopGamesParams) (*TopGamesResponse, error)

+ func (c *Client) GetUserAccessToken(code string) (*UserAccessTokenResponse, error)

+ func (c *Client) GetUsers(params *UsersParams) (*UsersResponse, error)

+ func (c *Client) GetUsersFollows(params *UsersFollowsParams) (*UsersFollowsResponse, error)

+ func (c *Client) GetVideos(params *VideosParams) (*VideosResponse, error)

+ func (c *Client) RefreshUserAccessToken(refreshToken string) (*RefreshTokenResponse, error)

+ func (c *Client) RevokeUserAccessToken(accessToken string) (*RevokeAccessTokenResponse, error)

+ func (c *Client) SetAppAccessToken(accessToken string)

+ func (c *Client) SetRedirectURI(uri string)

+ func (c *Client) SetScopes(scopes []string)

+ func (c *Client) SetUserAccessToken(accessToken string)

+ func (c *Client) SetUserAgent(userAgent string)

+ func (c *Client) UpdateUser(description string) (*UsersResponse, error)

+ type Clip struct

+ BroadcasterID string

+ CreatedAt string

+ CreatorID string

+ EmbedURL string

+ GameID string

+ ID string

+ Language string

+ ThumbnailURL string

+ Title string

+ URL string

+ VideoID string

+ ViewCount int

+ type ClipEditURL struct

+ EditURL string

+ ID string

+ type ClipsCreationRateLimit struct

+ Limit int

+ Remaining int

+ type ClipsParams struct

+ IDs []string

+ type ClipsResponse struct

+ Data ManyClips

+ type CreateClipResponse struct

+ Data ManyClipEditURLs

+ type EntitlementsUploadResponse struct

+ Data ManyEntitlementsUploadURLs

+ type EntitlementsUploadURL struct

+ URL string

+ type Game struct

+ BoxArtURL string

+ ID string

+ Name string

+ type GameAnalytic struct

+ GameID string

+ URL string

+ type GameAnalyticsResponse struct

+ Data ManyGameAnalytics

+ type GamesParams struct

+ IDs []string

+ Names []string

+ type GamesResponse struct

+ Data ManyGames

+ type HTTPClient interface

+ Do func(req *http.Request) (*http.Response, error)

+ type HearthstoneHero struct

+ Class string

+ Name string

+ Type string

+ type HearthstoneMetadata struct

+ Broadcaster HearthstonePlayerData

+ Opponent HearthstonePlayerData

+ type HearthstonePlayerData struct

+ Hero HearthstoneHero

+ type ManyClipEditURLs struct

+ ClipEditURLs []ClipEditURL

+ type ManyClips struct

+ Clips []Clip

+ type ManyEntitlementsUploadURLs struct

+ URLs []EntitlementsUploadURL

+ type ManyFollows struct

+ Follows []UserFollow

+ Pagination Pagination

+ Total int

+ type ManyGameAnalytics struct

+ GameAnalytics []GameAnalytic

+ type ManyGames struct

+ Games []Game

+ type ManyGamesWithPagination struct

+ Pagination Pagination

+ type ManyStreams struct

+ Pagination Pagination

+ Streams []Stream

+ type ManyStreamsMetadata struct

+ Pagination Pagination

+ Streams []StreamMetadata

+ type ManyUserBitTotals struct

+ DateRange BitsDateRange

+ Total int

+ UserBitTotals []UserBitTotal

+ type ManyUsers struct

+ Users []User

+ type ManyVideos struct

+ Pagination Pagination

+ Videos []Video

+ type Options struct

+ AppAccessToken string

+ ClientID string

+ ClientSecret string

+ HTTPClient HTTPClient

+ RateLimitFunc RateLimitFunc

+ RedirectURI string

+ Scopes []string

+ UserAccessToken string

+ UserAgent string

+ type OverwatchBroadcaster struct

+ Hero OverwatchHero

+ type OverwatchHero struct

+ Ability string

+ Name string

+ Role string

+ type OverwatchMetadata struct

+ Broadcaster OverwatchBroadcaster

+ type Pagination struct

+ Cursor string

+ type RateLimit struct

+ Limit int

+ Remaining int

+ Reset int64

+ type RateLimitFunc func(*Response) error

+ type RefreshTokenResponse struct

+ Data UserAccessCredentials

+ type Response struct

+ Data interface{}

+ type ResponseCommon struct

+ Error string

+ ErrorMessage string

+ ErrorStatus int

+ StatusCode int

+ type RevokeAccessTokenResponse struct

+ type Stream struct

+ CommunityIDs []string

+ GameID string

+ ID string

+ Language string

+ StartedAt time.Time

+ ThumbnailURL string

+ Title string

+ Type string

+ UserID string

+ ViewerCount int

+ type StreamMetadata struct

+ GameID string

+ Hearthstone HearthstoneMetadata

+ Overwatch OverwatchMetadata

+ UserID string

+ type StreamsMetadataParams StreamsParams

+ type StreamsMetadataRateLimit struct

+ Limit int

+ Remaining int

+ type StreamsMetadataResponse struct

+ Data ManyStreamsMetadata

+ type StreamsParams struct

+ After string

+ Before string

+ CommunityIDs []string

+ First int

+ GameIDs []string

+ Language []string

+ Type string

+ UserIDs []string

+ UserLogins []string

+ type StreamsResponse struct

+ Data ManyStreams

+ type Time struct

+ func (t *Time) UnmarshalJSON(b []byte) (err error)

+ type TopGamesParams struct

+ After string

+ Before string

+ First int

+ type TopGamesResponse struct

+ Data ManyGamesWithPagination

+ type User struct

+ BroadcasterType string

+ Description string

+ DisplayName string

+ Email string

+ ID string

+ Login string

+ OfflineImageURL string

+ ProfileImageURL string

+ Type string

+ ViewCount int

+ type UserAccessCredentials struct

+ AccessToken string

+ ExpiresIn int

+ RefreshToken string

+ Scopes []string

+ type UserAccessTokenResponse struct

+ Data UserAccessCredentials

+ type UserBitTotal struct

+ Rank int

+ Score int

+ UserID string

+ type UserFollow struct

+ FollowedAt time.Time

+ FromID string

+ ToID string

+ type UsersFollowsParams struct

+ After string

+ Before string

+ First int

+ FromID string

+ ToID string

+ type UsersFollowsResponse struct

+ Data ManyFollows

+ type UsersParams struct

+ IDs []string

+ Logins []string

+ type UsersResponse struct

+ Data ManyUsers

+ type Video struct

+ CreatedAt string

+ Description string

+ Duration string

+ ID string

+ Language string

+ PublishedAt string

+ ThumbnailURL string

+ Title string

+ Type string

+ URL string

+ UserID string

+ ViewCount int

+ Viewable string

+ type VideosParams struct

+ After string

+ Before string

+ First int

+ GameID string

+ IDs []string

+ Language string

+ Period string

+ Sort string

+ Type string

+ UserID string

+ type VideosResponse struct

+ Data ManyVideos

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL