api

Documentation

Index

• type Client
  • func NewClient(cookie string, timeout time.Duration, options ...ClientOption) *Client
  • func (c *Client) CreateQRLogin(ctx context.Context) (QRLoginChallenge, error)
  • func (c *Client) PollQRLogin(ctx context.Context, token string) (QRLoginResult, error)
  • func (c *Client) SearchGames(ctx context.Context, query Query) (json.RawMessage, error)
  • func (c *Client) SearchGeneral(ctx context.Context, query Query) (json.RawMessage, error)
  • func (c *Client) SearchTopics(ctx context.Context, query Query) (json.RawMessage, error)
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithClock(clock func() time.Time) ClientOption
  • func WithHTTPClient(httpClient *http.Client) ClientOption
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type ErrorKind
  • func Kind(err error) ErrorKind
• type QRLoginChallenge
• type QRLoginResult
• type QRLoginState
• type Query
• type Response

Types

type Client

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

func NewClient

func NewClient(cookie string, timeout time.Duration, options ...ClientOption) *Client

func (*Client) CreateQRLogin

func (c *Client) CreateQRLogin(ctx context.Context) (QRLoginChallenge, error)

func (*Client) PollQRLogin

func (c *Client) PollQRLogin(ctx context.Context, token string) (QRLoginResult, error)

func (*Client) SearchGames

func (c *Client) SearchGames(ctx context.Context, query Query) (json.RawMessage, error)

func (*Client) SearchGeneral

func (c *Client) SearchGeneral(ctx context.Context, query Query) (json.RawMessage, error)

func (*Client) SearchTopics

func (c *Client) SearchTopics(ctx context.Context, query Query) (json.RawMessage, error)

type ClientOption

type ClientOption func(*Client)

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

func WithClock

func WithClock(clock func() time.Time) ClientOption

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) ClientOption

type Error

type Error struct {
	Kind       ErrorKind
	Message    string
	StatusCode int
	Cause      error
}

func (*Error) Error

func (e *Error) Error() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

type ErrorKind

type ErrorKind string

const (
	ErrorAuth         ErrorKind = "auth"
	ErrorCaptcha      ErrorKind = "captcha"
	ErrorRateLimit    ErrorKind = "rate_limit"
	ErrorNetwork      ErrorKind = "network"
	ErrorUpstream     ErrorKind = "upstream"
	ErrorIncompatible ErrorKind = "incompatible"
)

func Kind

func Kind(err error) ErrorKind

type QRLoginChallenge

type QRLoginChallenge struct {
	URL       string
	Token     string
	ExpiresIn time.Duration
}

type QRLoginResult

type QRLoginResult struct {
	State        QRLoginState
	Message      string
	HeyboxID     string
	PKey         string
	ExpireAt     string
	XXHHHeyboxID string
}

type QRLoginState

type QRLoginState string

const (
	QRLoginWaiting   QRLoginState = "waiting"
	QRLoginScanned   QRLoginState = "scanned"
	QRLoginSucceeded QRLoginState = "succeeded"
	QRLoginExpired   QRLoginState = "expired"
)

type Query

type Query struct {
	Keyword string
	Type    string
	Sort    string
	Offset  int
	Limit   int
}

type Response

type Response struct {
	Status string          `json:"status"`
	Msg    string          `json:"msg"`
	Result json.RawMessage `json:"result"`
}