api

Documentation

Index

• type ACMClient
  • func NewACMClient() *ACMClient
  • func (client *ACMClient) Search(params *SearchParams, opts ...Option) (*SearchResponse, error)
• type Option
  • func WithContext(ctx context.Context) Option
• type Reference
• type ReferenceMetrics
• type SearchParams
• type SearchResponse

Types

type ACMClient

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

func NewACMClient

func NewACMClient() *ACMClient

func (*ACMClient) Search

func (client *ACMClient) Search(params *SearchParams, opts ...Option) (*SearchResponse, error)

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithContext

func WithContext(ctx context.Context) Option

type Reference

type Reference struct {
	Category   string
	Title      string
	Abstract   string
	DOI        *string
	PubDate    string
	Conference *string
	OpenAccess bool
	FreeAccess bool
	Metrics    ReferenceMetrics
}

type ReferenceMetrics

type ReferenceMetrics struct {
	Citations      int
	TotalDownloads *int
}

type SearchParams

type SearchParams struct {
	Request    string `schema:"AllField"`
	StartPage  *int   `schema:"startPage,omitempty"`
	PageSize   *int   `schema:"pageSize,omitempty"`
	BeforeYear *int   `schema:"BeforeYear,omitempty"`
	AfterYear  *int   `schema:"AfterYear,omitempty"`
}

type SearchResponse

type SearchResponse struct {
	Results    int
	References []*Reference
}