emojis

Documentation

Index

• type Client
  • func NewClient(opt ...requests.Option) Client
  • func (c Client) Get(ctx context.Context, req *GetReq, opt ...requests.Option) (*GetResponse, error)
• type GetReq
  • func (r *GetReq) HTTPRequest(ctx context.Context, opt ...requests.Option) (*http.Request, error)
  • func (r *GetReq) Rel(link string, resp *GetResponse) bool
• type GetResponse
  • func Get(ctx context.Context, req *GetReq, opt ...requests.Option) (*GetResponse, error)
  • func (r *GetResponse) HTTPResponse() *http.Response
  • func (r *GetResponse) ReadResponse(resp *http.Response) error
• type GetResponseBody

Types

type Client

type Client []requests.Option

Client is a set of options to apply to requests

func NewClient

func NewClient(opt ...requests.Option) Client

NewClient returns a new Client

func (Client) Get

func (c Client) Get(ctx context.Context, req *GetReq, opt ...requests.Option) (*GetResponse, error)

Get performs requests for "emojis/get"

Get emojis.

GET /emojis

https://developer.github.com/v3/emojis/#get-emojis

Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.

type GetReq

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

GetReq is request data for Client.Get

https://developer.github.com/v3/emojis/#get-emojis

Non-nil errors will have the type *requests.RequestError, octo.ResponseError or url.Error.

func (*GetReq) HTTPRequest

func (r *GetReq) HTTPRequest(ctx context.Context, opt ...requests.Option) (*http.Request, error)

HTTPRequest builds an *http.Request. Non-nil errors will have the type *requests.RequestError.

func (*GetReq) Rel

func (r *GetReq) Rel(link string, resp *GetResponse) bool

Rel updates this request to point to a relative link from resp. Returns false if the link does not exist. Handy for paging.

type GetResponse

type GetResponse struct {
	Data GetResponseBody
	// contains filtered or unexported fields
}

GetResponse is a response for Get

https://developer.github.com/v3/emojis/#get-emojis

func Get

func Get(ctx context.Context, req *GetReq, opt ...requests.Option) (*GetResponse, error)

Get performs requests for "emojis/get"

Get emojis.

GET /emojis

https://developer.github.com/v3/emojis/#get-emojis

func (*GetResponse) HTTPResponse

func (r *GetResponse) HTTPResponse() *http.Response

HTTPResponse returns the *http.Response

func (*GetResponse) ReadResponse

func (r *GetResponse) ReadResponse(resp *http.Response) error

ReadResponse reads an *http.Response. Non-nil errors will have the type octo.ResponseError.

type GetResponseBody

type GetResponseBody map[string]string

GetResponseBody is a response body for Get

https://developer.github.com/v3/emojis/#get-emojis