seventv

package
v0.0.0-...-9c6474c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 27, 2025 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

Package seventv provides a client to the 7TV API. https://7tv.io/docs

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrEmoteAlreadyEnabled indicates the given emote is already enabled.
	ErrEmoteAlreadyEnabled = errors.New("emote is already enabled")
	// ErrEmoteNotEnabled indicates the given emote is not enabled.
	ErrEmoteNotEnabled = errors.New("emote is not enabled")
	// ErrEmoteNotFound indicidates the emote was not found.
	ErrEmoteNotFound = errors.New("emote not found")
	// ErrNotAuthorized indicates the operation was not allowed.
	// Most likely, the bot is not an editor on the emote set in question.
	ErrNotAuthorized = errors.New("not authorized")
)
View Source 
var DefaultBaseURL = url.URL{Scheme: "https", Host: "7tv.io"}

DefaultBaseURL is the default base URL for the 7TV API.

Functions

This section is empty.

Types

type Client 

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

Client is a 7TV client.

func NewClient 

func NewClient(ctx context.Context, baseURL url.URL, accessToken string) *Client

NewClient creates a new 7TV API client.

func NewDefaultClient 

func NewDefaultClient() *Client

NewDefaultClient returns a new default 7TV API client.

func (*Client) AddEmote 

func (c *Client) AddEmote(ctx context.Context, emoteSetID, emoteID string) error

AddEmote adds a 7TV emote to an emote set.

func (*Client) AddEmoteWithAlias 

func (c *Client) AddEmoteWithAlias(ctx context.Context, emoteSetID, emoteID, alias string) error

AddEmoteWithAlias adds a 7TV emote to an emote set with a given name (alias). If useName is the blank string, the emote will not be aliased.

func (*Client) FetchUserConnectionByTwitchUserId 

func (c *Client) FetchUserConnectionByTwitchUserId(uid string) (*PlatformConnection, error)

FetchUserConnectionByTwitchUserId fetches a 7tv user+connection given a Twitch userid.

func (*Client) RemoveEmote 

func (c *Client) RemoveEmote(ctx context.Context, emoteSetID, emoteID string) error

RemoteEmote removes a 7TV emote from an emote set.

func (*Client) SetAccessToken 

func (c *Client) SetAccessToken(accessToken string)

SetAccessToken sets a new access token.

type Emote 

type Emote struct {
	// ID is the unique ID of the emote.
	// Example: "6535d68eaf0fd607b5e8e98f"
	ID string `json:"id"`
	// Name is the written name of the emote.
	// Example: "librarySecurity"
	Name string `json:"name"`
	// Flags are flags set on the set (?)
	// Appears to always be 0.
	// Use is unknown.
	Flags int `json:"flags"`
	// UpdateTime is the last update time of the emote (?)
	UpdateTime UnixTimeMs `json:"timestamp"`
	// Creator is the ID of the creator of the emote (?)
	Creator string `json:"actor_id"`
	// Data is extended data about this emote.
	Data EmoteData `json:"data,omitempty"`
}

Emote is an emote.

type EmoteData 

type EmoteData struct {
	// ID is the unique ID of the emote.
	// Example: "6535d68eaf0fd607b5e8e98f"
	ID string `json:"id"`
	// Name is the written name of the emote.
	// Example: "librarySecurity"
	Name string `json:"name"`
	// Flags are flags set on the set (?)
	// Appears to always be 0.
	// Use is unknown.
	Flags int `json:"flags"`
	// Flags are flags set on the set (?)
	// Appears to always be 0.
	// Use is unknown.
	Tags []string `json:"tags"`
	// Lifecycle is where this emote is in its lifecycle (?)
	// Mapping to states/strings is unknown.
	// Example: 3
	Lifecycle int `json:"lifecycle"`
	// States describe extended attributes about this emote.
	// Example: "LISTED", "NO_PERSONAL"
	States []string `json:"state"`
	// Listed is whether the emote is listed.
	Listed bool `json:"listed"`
	// Animated is whether the emote is animated.
	Animated bool `json:"animated"`
	// Owner is the owner of the set.
	Owner Owner `json:"owner"`
	// Host is information about where to load the emote from.
	Host Host `json:"host"`
}

EmoteData is extended data about an emote.

type EmoteSet 

type EmoteSet struct {
	// ID is the unique ID of the set.
	// Example: "621f13b614f489808df5d58e"
	ID string `json:"id"`
	// Name is the display name of the set.
	// Example: "airforce2700's Emotes"
	Name string `json:"name"`
	// Flags are flags set on the set (?)
	// Appears to always be 0.
	// Use is unknown.
	Flags int `json:"flags"`
	// Tags are tags on the emote set.
	// Appears to always be empty.
	// Use is unknown.
	Tags []string `json:"tags"`
	// Immutable is whether the set is immutable.
	// Appears to always be false.
	// Use is unknown.
	Immutable bool `json:"immutable"`
	// Privileged is whether the set is privileged.
	// Appears to always be false.
	// Use is unknown.
	Privileged bool `json:"privileged"`
	// Emotes are the emotes in the set.
	Emotes []Emote `json:"emotes"`
	// EmoteCount is the number of emotes in the set.
	EmoteCount int `json:"emote_count"`
	// Capacity is the capacity of the set.
	Capacity int `json:"capacity"`
	// Owner is the owner of the set.
	Owner Owner `json:"owner"`
}

EmoteSet is an emote set.

type File 

type File struct {
	// Name is the file name.
	// Example: "1x.avif"
	Name string `json:"name"`
	// Static name is the "static name of the emote".
	// Example: "1x_static.avif"
	// Use is unknown.
	StaticName string `json:"static_name"`
	// Width is the width of the emote.
	// Example: 32
	Width int `json:"width"`
	// Height is the height of the emote.
	// Example: 32
	Height int `json:"height"`
	// FrameCount is the number of frames in the emote.
	// If the emote is not animated, it is 1.
	FrameCount int `json:"frame_count"`
	// Size is the size of the file in bytes.
	Size int `json:"size"`
	// Format is the format the image is in.
	// Examples: "AVIF", "WEBP"
	Format string `json:"format"`
}

File is information on how to load an emote.

type Host 

type Host struct {
	// BaseURL is the base URL to use for loading the emote.
	// Example: "//cdn.7tv.app/emote/6535d68eaf0fd607b5e8e98f"
	BaseURL string `json:"url"`
	// Files are the individual files to use when loading the emote.
	// There are generally multiple formats and sizes.
	Files []File `json:"files"`
}

Host is information about where to load an emote from.

type ModifyEmoteSetMutation 

type ModifyEmoteSetMutation struct {
	EmoteSet struct {
		ID     string
		Emotes []struct {
			ID   string
			Name string
		} `graphql:"emotes(id: $emote_id, action: $action)"`
	} `graphql:"emoteSet(id: $emote_set_id)"`
}

ModifyEmoteSetMutation is a GraphQL mutation to modify an emote set.

type ModifyEmoteSetWithNameMutation 

type ModifyEmoteSetWithNameMutation struct {
	EmoteSet struct {
		ID     string
		Emotes []struct {
			ID   string
			Name string
		} `graphql:"emotes(id: $emote_id, action: $action, name: $name)"`
	} `graphql:"emoteSet(id: $emote_set_id)"`
}

ModifyEmoteSetWithNameMutation is a GraphQL mutation to modify an emote set and set the emote's name.

type Owner 

type Owner struct {
	// ID is the user's ID.
	// Example: "621f13b614f489808df5d58e"
	ID string `json:"id"`
	// Username is the user's username.
	// Example: "airforce2700"
	Username string `json:"username"`
	// DisplayName is the user's display name.
	DisplayName string `json:"display_name"`
	// AvatarURL is the URL of the user's avatar.
	// Notably, does not include the scheme and starts with `//`.
	// Example: "//cdn.7tv.app/user/<id>/<img>/3x.webp"
	// If the user is not a 7TV subscriber or does not have an avatar,
	// this value will be "//cdn.7tv.app/"
	AvatarURL string `json:"avatar_url"`
	// Style is this user's style information.
	Style Style `json:"style"`
	// RoleIDs are the IDs of the roles the user has.
	// Example: "62b48deb791a15a25c2a0354"
	RoleIDs []string `json:"roles"`
}

Owner is the owner of an emote. It's a subset of the fields from `User`.

type PlatformConnection 

type PlatformConnection struct {
	// Platform is the platform connected to.
	// Examples: "TWITCH", "DISCORD", "KICK"
	Platform string `json:"platform"`
	// ID is the user's ID on the platform.
	// Example: "181950834"
	ID string `json:"id"`
	// Username is the user's username on the platform.
	// Example: "airforce2700"
	Username string `json:"username"`
	// DisplayName is the user's display name on the platform.
	DisplayName string `json:"display_name"`
	// LinkedAt is when the connection was created.
	LinkedAt UnixTimeMs `json:"linked_at"`
	// EmoteCapacity is the number of emotes that can be
	// used at one time on the connection.
	EmoteCapacity int `json:"emote_capacity"`
	// EmoteSetID is the unique ID of the active emote set on this connection.
	// It appears to typically be unset.
	EmoteSetID *string `json:"emote_set_id"`
	// EmoteSet is the active emote set on this connection.
	EmoteSet EmoteSet `json:"emote_set"`
	// User is the 7TV user for this connection.
	User User `json:"user"`
}

PlatformConnection is a connection between a 7TV account and an external platform account.

type Style 

type Style struct {
	// Paint is the user's active name paint.
	// It appears to always be negative.
	Paint int `json:"color,omitempty"`
}

Style is style information (?) Use is unknown.

type UnixTimeMs 

type UnixTimeMs time.Time

UnixTimeMs is the unix timestamp in milliseconds. It is the format the 7TV API regularly returns timestamps in.

func (UnixTimeMs) MarshalJSON 

func (t UnixTimeMs) MarshalJSON() ([]byte, error)

MarshalJSON marshals this type into JSON.

func (*UnixTimeMs) UnmarshalJSON 

func (t *UnixTimeMs) UnmarshalJSON(in []byte) error

UnmarshalJSON unmarshals this type from JSON.

type User 

type User struct {
	// ID is the user's ID.
	// Example: "621f13b614f489808df5d58e"
	ID string `json:"id"`
	// Username is the user's username.
	// Example: "airforce2700"
	Username string `json:"username"`
	// DisplayName is the user's display name.
	DisplayName string `json:"display_name"`
	// CreateTime is when the user created was created.
	CreateTime UnixTimeMs `json:"created_at"`
	// AvatarURL is the URL of the user's avatar.
	// Notably, does not include the scheme and starts with `//`.
	// Example: "//cdn.7tv.app/user/<id>/<img>/3x.webp"
	// If the user is not a 7TV subscriber or does not have an avatar,
	// this value will be "//cdn.7tv.app/"
	AvatarURL string `json:"avatar_url"`
	// Bio is this user's bio.
	Bio string `json:"biography"`
	// Style is this user's style information.
	Style Style `json:"style"`
	// RoleIDs are the IDs of the roles the user has.
	// Example: "62b48deb791a15a25c2a0354"
	RoleIDs []string `json:"roles"`
	// Connections are the user's platform connections.
	// Note that the `EmoteSet`s in each connection
	// do not include the emotes themselves.
	Connections []PlatformConnection `json:"connections"`
}

User is a 7TV user.

Source Files

View all Source files

Directories

Path Synopsis
Package gqltypes contains types used in the 7TV GraphQL API.
 Package gqltypes contains types used in the 7TV GraphQL API.
Package seventvtest provides helpers for testing connections to the 7TV API.
 Package seventvtest provides helpers for testing connections to the 7TV API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.