lbryinc

Documentation

Index

• type APIResponse
• type Client
  • func NewClient(authToken string, opts *ClientOpts) Client
  • func (c Client) Call(object, method string, params map[string]interface{}) (ResponseData, error)
  • func (c Client) UserHasVerifiedEmail() (ResponseData, error)
  • func (c Client) UserMe() (ResponseData, error)
• type ClientOpts
• type ResponseData

Types

type APIResponse

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

APIResponse reflects internal-apis JSON response format.

type Client

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

func NewClient(authToken string, opts *ClientOpts) Client

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

func (Client) Call

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 (Client) UserHasVerifiedEmail

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

func (Client) UserMe

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

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

type ClientOpts

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

type ResponseData map[string]interface{}

ResponseData is a map containing parsed json response.