handler

package

v1.2.0 Latest Latest Go to latest Published: Jul 22, 2024 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Scarlet-Spark/hoyoapi

Links

Open Source Insights

Documentation ¶

Index ¶

type Handler
- func NewHandler(cookie middleware.Cookie) Handler
- func (handler Handler) Send(request Request) (map[string]interface{}, error)
type Request
type RequestBuilder
- func NewRequest(endpoint string, method string) *RequestBuilder

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Handler ¶

type Handler struct {
	middleware.Cookie
	// contains filtered or unexported fields
}

Base handler for dealing with HTTP request processes. This ranges from sending HTTP requests to HoYoLab endpoints, parsing responses, and setting cookies.

func NewHandler ¶

func NewHandler(cookie middleware.Cookie) Handler

Constructor.

func (Handler) Send ¶

func (handler Handler) Send(request Request) (map[string]interface{}, error)

Sends a HTTP request. Returns a generic map from the unmarshalled response. Specific retcode errors are handled by their respective clients.

type Request ¶

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

HTTP request wrapper for holding parameters required for HoYoLab endpoints. Used by Handler to be parsed into a HTTP request.

type RequestBuilder ¶

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

Request builder that defines a request structure using the builder pattern.

func NewRequest ¶

func NewRequest(endpoint string, method string) *RequestBuilder

Constructor.

func (*RequestBuilder) AddBody ¶

func (builder *RequestBuilder) AddBody(key string, value interface{}) *RequestBuilder

Add body.

func (*RequestBuilder) AddCookie ¶

func (builder *RequestBuilder) AddCookie(cookie middleware.Cookie) *RequestBuilder

Add cookie to request header.

func (*RequestBuilder) AddDynamicSecret ¶

func (builder *RequestBuilder) AddDynamicSecret(salt constants.DynamicSecret) *RequestBuilder

Add dynamic secret to request header.

func (*RequestBuilder) AddHeader ¶

func (builder *RequestBuilder) AddHeader(key string, value string) *RequestBuilder

Add header.

func (*RequestBuilder) AddLanguage ¶

func (builder *RequestBuilder) AddLanguage(language string) *RequestBuilder

Add language to request header.

func (*RequestBuilder) AddParam ¶

func (builder *RequestBuilder) AddParam(key string, value string) *RequestBuilder

Add query parameter.

func (*RequestBuilder) AddReferer ¶

func (builder *RequestBuilder) AddReferer(referer string) *RequestBuilder

Add referer to request header.

func (*RequestBuilder) Build ¶

func (builder *RequestBuilder) Build() Request

Return built request instance.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL