api

Documentation

Overview

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

Index

• func GetClientInformation() (clientInformation, error)
• func NewRequest(method string, path string, queryParameters []string, body []byte, ...) error
• func ValidOptions(method string) []string
• type RLClient
  • func NewClient(l *rate.Limiter) *RLClient
  • func (c *RLClient) Do(req *http.Request) (*http.Response, error)

Functions

func GetClientInformation

func GetClientInformation() (clientInformation, error)

func NewRequest

func NewRequest(method string, path string, queryParameters []string, body []byte, prettyPrint bool, autopaginate *int, verbose bool) error

NewRequest is used to request data from the Twitch API using a HTTP GET request- this function is a wrapper for the apiRequest function that handles the network call

func ValidOptions

func ValidOptions(method string) []string

ValidOptions returns a list of supported endpoints given a specified method as noted in the map endpointMethodSupports, which is located in resources.go of this package.

Types

type RLClient

type RLClient struct {
	RateLimiter *rate.Limiter
	// contains filtered or unexported fields
}

func NewClient

func NewClient(l *rate.Limiter) *RLClient

func (*RLClient) Do

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