gh

Documentation

Index

• type GitHubGateway
  • func NewGitHubGateway(ctx context.Context, accessToken, apiURL string) (GitHubGateway, error)
  • func (ghg *GitHubGateway) GetIssues() ([]GitHubItem, error)
  • func (ghg *GitHubGateway) GetNotifications() ([]GitHubItem, error)
  • func (ghg *GitHubGateway) GetPRs() ([]GitHubItem, error)
• type GitHubItem
  • func (item GitHubItem) Key() string
  • func (item GitHubItem) String() string

Types

type GitHubGateway

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

func NewGitHubGateway

func NewGitHubGateway(ctx context.Context, accessToken, apiURL string) (GitHubGateway, error)

func (*GitHubGateway) GetIssues

func (ghg *GitHubGateway) GetIssues() ([]GitHubItem, error)

GetIssues downloads and returns the issues for the user authenticated to c, transformed to GitHubItems.

func (*GitHubGateway) GetNotifications

func (ghg *GitHubGateway) GetNotifications() ([]GitHubItem, error)

func (*GitHubGateway) GetPRs

func (ghg *GitHubGateway) GetPRs() ([]GitHubItem, error)

type GitHubItem

type GitHubItem struct {
	Title   string
	HTMLURL string
	APIURL  string
	K       string
}

GitHubItem is a simple, unified structure we can use to represent issues, PRs and notifications containing only the information the rest of the program requires.

func (GitHubItem) Key

func (item GitHubItem) Key() string

Key meets the Keyed interface used for creating delta operations in github2omnifocus. For the desired state, this is a unique key for the item derived from the GitHub data.

func (GitHubItem) String

func (item GitHubItem) String() string