githubql

Documentation

Index

• type AddReactionInput
• type Boolean
  • func NewBoolean(v Boolean) *Boolean
• type Client
  • func NewClient(httpClient *http.Client) *Client
  • func (c *Client) Mutate(ctx context.Context, m interface{}, variables map[string]interface{}) error
  • func (c *Client) Query(ctx context.Context, q interface{}, variables map[string]interface{}) error
• type DateTime
  • func NewDateTime(v DateTime) *DateTime
• type Float
  • func NewFloat(v Float) *Float
• type GitObjectID
  • func NewGitObjectID(v GitObjectID) *GitObjectID
• type GitTimestamp
  • func NewGitTimestamp(v GitTimestamp) *GitTimestamp
• type HTML
  • func NewHTML(v HTML) *HTML
• type ID
  • func NewID(v ID) *ID
• type Int
  • func NewInt(v Int) *Int
• type ReactionContent
• type RemoveReactionInput
• type String
  • func NewString(v String) *String
• type URI
  • func NewURI(v URI) *URI
• type X509Certificate
  • func NewX509Certificate(v X509Certificate) *X509Certificate

Types

type AddReactionInput

type AddReactionInput struct {
	// The Node ID of the subject to modify. (Required.)
	SubjectID ID `json:"subjectId"`
	// The name of the emoji to react with. (Required.)
	Content ReactionContent `json:"content"`

	// A unique identifier for the client performing the mutation. (Optional.)
	ClientMutationID *String `json:"clientMutationId,omitempty"`
}

AddReactionInput is an autogenerated input type of AddReaction.

type Boolean

type Boolean bool

Boolean represents true or false values.

func NewBoolean

func NewBoolean(v Boolean) *Boolean

NewBoolean is a helper to make a new *Boolean.

type Client

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

func NewClient

func NewClient(httpClient *http.Client) *Client

func (*Client) Mutate

func (c *Client) Mutate(ctx context.Context, m interface{}, variables map[string]interface{}) error

THINK: Consider having Mutate accept input separate from variables (since they're often left nil). For convenience.

func (*Client) Query

func (c *Client) Query(ctx context.Context, q interface{}, variables map[string]interface{}) error

type DateTime

type DateTime struct{ time.Time }

DateTime is an ISO-8601 encoded UTC date string.

func NewDateTime

func NewDateTime(v DateTime) *DateTime

NewDateTime is a helper to make a new *DateTime.

type Float

type Float float64

Float represents signed double-precision fractional values as specified by IEEE 754.

func NewFloat

func NewFloat(v Float) *Float

NewFloat is a helper to make a new *Float.

type GitObjectID

type GitObjectID string // TODO: Confirm.

GitObjectID is a Git object ID.

func NewGitObjectID

func NewGitObjectID(v GitObjectID) *GitObjectID

NewGitObjectID is a helper to make a new *GitObjectID.

type GitTimestamp

type GitTimestamp struct{ time.Time }

GitTimestamp is an ISO-8601 encoded date string. Unlike the DateTime type, GitTimestamp is not converted in UTC.

func NewGitTimestamp

func NewGitTimestamp(v GitTimestamp) *GitTimestamp

NewGitTimestamp is a helper to make a new *GitTimestamp.

type HTML

type HTML string

HTML is a string containing HTML code.

func NewHTML

func NewHTML(v HTML) *HTML

NewHTML is a helper to make a new *HTML.

type ID

type ID string

ID represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

func NewID

func NewID(v ID) *ID

NewID is a helper to make a new *ID.

type Int

type Int int32

Int represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

func NewInt

func NewInt(v Int) *Int

NewInt is a helper to make a new *Int.

type ReactionContent

type ReactionContent string

ReactionContent represents emojis that can be attached to Issues, Pull Requests and Comments.

const (
	ThumbsUp   ReactionContent = "THUMBS_UP"   // Represents the 👍 emoji.
	ThumbsDown ReactionContent = "THUMBS_DOWN" // Represents the 👎 emoji.
	Laugh      ReactionContent = "LAUGH"       // Represents the 😄 emoji.
	Hooray     ReactionContent = "HOORAY"      // Represents the 🎉 emoji.
	Confused   ReactionContent = "CONFUSED"    // Represents the 😕 emoji.
	Heart      ReactionContent = "HEART"       // Represents the ❤️ emoji.
)

Emojis that can be attached to Issues, Pull Requests and Comments.

type RemoveReactionInput

type RemoveReactionInput struct {
	// The Node ID of the subject to modify. (Required.)
	SubjectID ID `json:"subjectId"`
	// The name of the emoji to react with. (Required.)
	Content ReactionContent `json:"content"`

	// A unique identifier for the client performing the mutation. (Optional.)
	ClientMutationID *String `json:"clientMutationId,omitempty"`
}

RemoveReactionInput is an autogenerated input type of RemoveReaction.

type String

type String string

String represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

func NewString

func NewString(v String) *String

NewString is a helper to make a new *String.

type URI

type URI string

URI is an RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

func NewURI

func NewURI(v URI) *URI

NewURI is a helper to make a new *URI.

type X509Certificate

type X509Certificate string

X509Certificate is a valid x509 certificate string.

func NewX509Certificate

func NewX509Certificate(v X509Certificate) *X509Certificate

NewX509Certificate is a helper to make a new *X509Certificate.