twitter

package

v0.0.0-...-74ff373 Latest Latest Go to latest Published: Nov 8, 2020 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package twitter partially implements the Twitter API.

This section is empty.

View Source

var (
	// ErrInvalidImage is returned when an image is invalid.
	ErrInvalidImage = errors.New("twitter: invalid image provided")
)

View Source

var ErrInvalidUser = errors.New("twitter: invalid user provided")

ErrInvalidUser is returned when no user is provided.

This section is empty.

type APIError struct {
	Errors []ErrorDetail `json:"errors"`
}

APIError is the response from Twitter's API when an error occurs.

func (e APIError) Error() string

Error implements the error interface.

type Config struct {
	ConsumerKey      string
	ConsumerSecret   string
	OAuthToken       string
	OAuthTokenSecret string
}

Config configures a Twitter client for use in interacting with the Twitter API.

type ErrorDetail struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

ErrorDetail details what went wrong when the Twitter API returns an error.

type Settings struct {
	ScreenName string `json:"screen_name"`
}

Settings partially defines the account setting object returned by the Twitter API.

type Twitter struct {
	// contains filtered or unexported fields
}

Twitter is an HTTP client responsible for interacting with the Twitter API.

func New(conf Config) *Twitter

New creates a new Twitter client.

func (t *Twitter) GetAccountSettings() (*Settings, error)

GetAccountSettings retrieves the authenticated account's settings from Twitter's API.

func (t *Twitter) UpdateProfileImage(image string) error

UpdateProfileImage uploads a new profile image to the authenticated user's account.

func (t *Twitter) UserShow(screenName string) (*User, error)

UserShow retrieves a user from Twitter's API.

type User struct {
	ProfileImageURLHTTPS string `json:"profile_image_url_https"`
	DefaultProfileImage  bool   `json:"default_profile_image"`
}

User is a partial definition of a Twitter user.