The highest tagged major version is v3.

lbryinc

package

v2.7.1 Latest Latest Go to latest Published: Feb 16, 2021 License: MIT Imports: 9 Imported by: 2

Details

This section is empty.

This section is empty.

This section is empty.

type APIError struct {
	Err error
}

APIError wraps errors returned by LBRY API server to discern them from other kinds (like http errors).

func (e APIError) Error() string

type APIResponse struct {
	Success bool          `json:"success"`
	Error   *string       `json:"error"`
	Data    *ResponseData `json:"data"`
}

APIResponse reflects internal-apis JSON response format.

type Client struct {
	AuthToken string
	Logger    *log.Logger
	// contains filtered or unexported fields
}

Client stores data about internal-apis call it is about to make.

func NewClient(authToken string, opts *ClientOpts) Client

NewClient returns a client instance for internal-apis. It requires authToken to be provided for authentication.

func (c Client) Call(object, method string, params map[string]interface{}) (ResponseData, error)

Call calls a remote internal-apis server, returning a response, wrapped into standardized API Response struct.

func (c Client) UserHasVerifiedEmail() (ResponseData, error)

UserHasVerifiedEmail calls has_verified_email method.

func (c Client) UserMe() (ResponseData, error)

UserMe returns user details for the user associated with the current auth_token.

type ClientOpts struct {
	ServerAddress string
	RemoteIP      string
}

ClientOpts allow to provide extra parameters to NewClient: - ServerAddress - RemoteIP — to forward the IP of a frontend client making the request

type ResponseData map[string]interface{}

ResponseData is a map containing parsed json response.