接口

接口充当父对象，其他对象可以从中继承。

本文内容

关于接口

接口 充当父对象，其他对象可以从中继承。

例如，Lockable 是一个接口，因为 Issue 和 PullRequest 对象都可以被锁定。接口有自己的命名字段列表，这些字段由实现对象共享。

有关更多信息，请参阅“GraphQL 简介”。

参与者

表示可以在 GitHub 上执行操作的对象。通常是用户或机器人。

Actor 由以下实现

Actor 的字段

名称描述

avatarUrl (URI!)

指向参与者公开头像的 URL。

avatarUrl 的参数

  • size (Int)

    生成的正方形图像的大小。

login (String!)

参与者的用户名。

resourcePath (URI!)

此参与者的 HTTP 路径。

url (URI!)

此参与者的 HTTP URL。

公告横幅

表示公告横幅。

AnnouncementBanner 由以下实现

AnnouncementBanner 的字段

名称描述

announcement (String)

公告的文本。

announcementCreatedAt (DateTime)

创建公告的日期。

announcementExpiresAt (DateTime)

公告的到期日期（如果有）。

announcementUserDismissible (Boolean)

用户是否可以关闭公告。

可分配

可以将用户分配到的对象。

Assignable 由以下实现

Assignable 的字段

名称描述

assignees (UserConnection!)

分配给此对象的用户列表。

assignees 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

审计条目

审计日志中的一个条目。

AuditEntry 由以下实现

AuditEntry 的字段

名称描述

action (String!)

操作名称。

actor (AuditEntryActor)

发起操作的用户。

actorIp (String)

参与者的 IP 地址。

actorLocation (ActorLocation)

Actor 位置的可读表示。

actorLogin (String)

发起操作的用户用户名。

actorResourcePath (URI)

Actor 的 HTTP 路径。

actorUrl (URI)

Actor 的 HTTP URL。

createdAt (PreciseDateTime!)

操作发起的时刻。

operationType (OperationType)

操作对应的操作类型。

user (User)

受操作影响的用户。

userLogin (String)

对于涉及两个用户的操作，actor 是发起者，user 是受影响的用户。

userResourcePath (URI)

用户的 HTTP 路径。

userUrl (URI)

用户的 HTTP URL。

可关闭对象

可以关闭的对象。

Closable 由以下对象实现

Closable 的字段

名称描述

closed (Boolean!)

指示对象是否已关闭（关闭的定义可能取决于类型）。

closedAt (DateTime)

标识对象关闭的日期和时间。

viewerCanClose (Boolean!)

指示查看者是否可以关闭该对象。

viewerCanReopen (Boolean!)

指示查看者是否可以重新打开该对象。

评论

表示一条评论。

Comment 由以下对象实现

Comment 的字段

名称描述

author (Actor)

撰写评论的 Actor。

authorAssociation (CommentAuthorAssociation!)

作者与评论主题的关联。

body (String!)

评论正文（Markdown 格式）。

bodyHTML (HTML!)

渲染成 HTML 的评论正文。

bodyText (String!)

渲染成文本的评论正文。

createdAt (DateTime!)

标识对象创建的日期和时间。

createdViaEmail (Boolean!)

检查此评论是否通过电子邮件回复创建。

editor (Actor)

编辑评论的 Actor。

id (ID!)

评论对象的节点 ID。

includesCreatedEdit (Boolean!)

检查此评论是否已编辑，以及是否包含具有创建数据的编辑。

lastEditedAt (DateTime)

编辑最后一次编辑的时刻。

publishedAt (DateTime)

标识评论发布时间。

updatedAt (DateTime!)

标识对象上次更新的日期和时间。

userContentEdits (UserContentEditConnection)

此内容的编辑列表。

userContentEdits 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

viewerDidAuthor (Boolean!)

查看者是否撰写了此评论。

贡献

表示用户在 GitHub 上做出的贡献，例如创建问题。

Contribution 由以下对象实现

Contribution 的字段

名称描述

isRestricted (Boolean!)

此贡献是否与您无权访问的记录相关联。例如，您自己的“第一个问题”贡献可能是在您无法再访问的仓库中做出的。

occurredAt (DateTime!)

此贡献做出的时间。

resourcePath (URI!)

此贡献的 HTTP 路径。

url (URI!)

此贡献的 HTTP URL。

user (User!)

做出此贡献的用户。

可删除对象

可以删除的实体。

Deletable 由以下对象实现

Deletable 的字段

名称描述

viewerCanDelete (Boolean!)

检查当前查看者是否可以删除此对象。

企业审计条目数据

包含企业帐户信息的审计条目的元数据。

EnterpriseAuditEntryData 由以下对象实现

EnterpriseAuditEntryData 的字段

名称描述

enterpriseResourcePath (URI)

此企业的 HTTP 路径。

enterpriseSlug (String)

企业的 slug。

enterpriseUrl (URI)

此企业的 HTTP URL。

Git 对象

表示一个 Git 对象。

GitObject 由以下对象实现

GitObject 的字段

名称描述

abbreviatedOid (String!)

Git 对象 ID 的缩写版本。

commitResourcePath (URI!)

此 Git 对象的 HTTP 路径。

commitUrl (URI!)

此 Git 对象的 HTTP URL。

id (ID!)

GitObject 对象的节点 ID。

oid (GitObjectID!)

Git 对象 ID。

repository (Repository!)

Git 对象所属的仓库。

Git 签名

关于提交或标签上的签名（GPG 或 S/MIME）的信息。

GitSignature 由以下对象实现

GitSignature 的字段

名称描述

email (String!)

用于签署此对象的电子邮件。

isValid (Boolean!)

如果签名有效且已由 GitHub 验证，则为真。

payload (String!)

GPG 签署对象的有效负载。原始 ODB 对象，不包含签名标头。

signature (String!)

来自对象的 ASCII 编码签名标头。

signer (User)

与签署此提交的电子邮件相对应的 GitHub 用户。

state (GitSignatureState!)

此签名的状态。如果签名有效且已由 GitHub 验证，则为 VALID，否则表示签名被视为无效的原因。

wasSignedByGitHub (Boolean!)

如果签名是用 GitHub 的签名密钥生成的，则为真。

悬停卡上下文

悬停卡的单独一行。

HovercardContext 由以下对象实现

HovercardContext 的字段

名称描述

message (String!)

描述此上下文的字符串。

octicon (String!)

与上下文一起使用的 octicon。

可标记对象

可以为其分配标签的对象。

Labelable 由以下类型实现

Labelable 的字段

名称描述

labels (LabelConnection)

与对象关联的标签列表。

labels 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • orderBy (LabelOrder)

    从连接返回的标签的排序选项。

viewerCanLabel (Boolean!)

指示查看者是否可以编辑此对象的标签。

Lockable

可以锁定的对象。

Lockable 由以下类型实现

Lockable 的字段

名称描述

activeLockReason (LockReason)

对话被锁定的原因。

locked (Boolean!)

如果对象被锁定，则为true。

MemberStatusable

具有可以设置状态消息的成员的实体。

MemberStatusable 由以下类型实现

MemberStatusable 的字段

名称描述

memberStatuses (UserStatusConnection!)

获取此实体的成员设置的状态消息，这些消息要么是公开的，要么仅对组织可见。

memberStatuses 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

Migration

表示 GitHub Enterprise Importer (GEI) 迁移。

Migration 由以下类型实现

Migration 的字段

名称描述

continueOnError (Boolean!)

迁移标志，指示在发生错误时继续执行。

createdAt (DateTime!)

标识对象创建的日期和时间。

databaseId (String)

标识数据库中的主键。

failureReason (String)

迁移失败的原因。

id (ID!)

迁移对象的节点 ID。

migrationLogUrl (URI)

迁移日志的 URL（在迁移完成后 1 天后过期）。

migrationSource (MigrationSource!)

迁移源。

repositoryName (String!)

目标存储库名称。

sourceUrl (URI!)

迁移源 URL，例如 https://github.com 或 https://monalisa.ghe.com。

state (MigrationState!)

迁移状态。

warningsCount (Int!)

此迁移遇到的警告数量。要查看警告，请查看 迁移日志。

Minimizable

可以最小化的实体。

Minimizable 由以下类型实现

Minimizable 的字段

名称描述

isMinimized (Boolean!)

返回注释是否已最小化。

minimizedReason (String)

返回注释被最小化的原因。其中之一为 abuse、off-topic、outdated、resolved、duplicate 和 spam。请注意，这些值的案例和格式与 MinimizeComment 变异的输入不同。

viewerCanMinimize (Boolean!)

检查当前查看者是否可以最小化此对象。

Node

具有 ID 的对象。

Node 由以下类型实现

Node 的字段

名称描述

id (ID!)

对象的 ID。

OauthApplicationAuditEntryData

操作为 oauth_application.* 的审计条目元数据。

OauthApplicationAuditEntryData 由以下类型实现

OauthApplicationAuditEntryData 的字段

名称描述

oauthApplicationName (String)

OAuth 应用程序的名称。

oauthApplicationResourcePath (URI)

OAuth 应用程序的 HTTP 路径。

oauthApplicationUrl (URI)

OAuth 应用程序的 HTTP URL。

OrganizationAuditEntryData

操作为 org.* 的审计条目元数据。

OrganizationAuditEntryData 由以下类型实现

OrganizationAuditEntryData 的字段

名称描述

organization (Organization)

与审计条目关联的组织。

organizationName (String)

组织的名称。

organizationResourcePath (URI)

组织的 HTTP 路径。

organizationUrl (URI)

组织的 HTTP URL。

PackageOwner

表示软件包的所有者。

PackageOwner 由以下类型实现

PackageOwner 的字段

名称描述

id (ID!)

PackageOwner 对象的节点 ID。

packages (PackageConnection!)

所有者下的软件包列表。

packages 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • names ([String])

    按名称查找软件包。

  • packageType (PackageType)

    按类型过滤注册表软件包。

  • repositoryId (ID)

    按 ID 查找存储库中的软件包。

ProfileOwner

表示 GitHub 上任何具有个人资料页面的实体。

ProfileOwner 由以下类型实现

ProfileOwner 的字段

名称描述

anyPinnableItems (Boolean!)

确定此存储库所有者是否有任何可以固定到其个人资料的项目。

anyPinnableItems 的参数

email (String)

公共个人资料电子邮件。

id (ID!)

ProfileOwner 对象的节点 ID。

itemShowcase (ProfileItemShowcase!)

展示个人资料所有者已策划或已根据受欢迎程度自动选择的存储库和 Gist 的选择。

location (String)

公共个人资料位置。

login (String!)

用于登录的用户名。

name (String)

公共个人资料名称。

pinnableItems (PinnableItemConnection!)

此个人资料所有者可以固定到其个人资料的存储库和 Gist 列表。

pinnableItems 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

pinnedItems (PinnableItemConnection!)

此个人资料所有者已将其固定到其个人资料的存储库和 Gist 列表。

pinnedItems 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

pinnedItemsRemaining (Int!)

返回此个人资料所有者可以将其固定到其个人资料的项目数量。

viewerCanChangePinnedItems (Boolean!)

查看者是否可以将存储库和 Gist 固定到个人资料？

websiteUrl (URI)

公共个人资料网站 URL。

ProjectOwner

表示项目的拥有者。

ProjectOwner 由以下内容实现

ProjectOwner 的字段

名称描述

id (ID!)

ProjectOwner 对象的节点 ID。

project (Project)

按编号查找项目。

project 的参数

  • number (Int!)

    要查找的项目编号。

projects (ProjectConnection!)

所有者下项目的列表。

projects 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • orderBy (ProjectOrder)

    从连接返回的项目的排序选项。

  • search (String)

    用于搜索项目的查询，目前仅按名称搜索。

projectsResourcePath (URI!)

列出所有者项目的 HTTP 路径。

projectsUrl (URI!)

列出所有者项目的 HTTP URL。

viewerCanCreateProjects (Boolean!)

当前查看者是否可以在此所有者上创建新项目。

ProjectV2FieldCommon

不同项目字段类型中的公共字段。

ProjectV2FieldCommon 由以下内容实现

ProjectV2FieldCommon 的字段

名称描述

createdAt (DateTime!)

标识对象创建的日期和时间。

dataType (ProjectV2FieldType!)

字段的类型。

databaseId (Int)

标识数据库中的主键。

id (ID!)

ProjectV2FieldCommon 对象的节点 ID。

name (String!)

项目字段的名称。

project (ProjectV2!)

包含此字段的项目。

updatedAt (DateTime!)

标识对象上次更新的日期和时间。

ProjectV2ItemFieldValueCommon

不同项目字段值类型中的公共字段。

ProjectV2ItemFieldValueCommon 由以下内容实现

ProjectV2ItemFieldValueCommon 的字段

名称描述

createdAt (DateTime!)

标识对象创建的日期和时间。

creator (Actor)

创建项目的参与者。

databaseId (Int)

标识数据库中的主键。

field (ProjectV2FieldConfiguration!)

包含此值的项目字段。

id (ID!)

ProjectV2ItemFieldValueCommon 对象的节点 ID。

item (ProjectV2Item!)

包含此值的项目项。

updatedAt (DateTime!)

标识对象上次更新的日期和时间。

ProjectV2Owner

表示项目的拥有者。

ProjectV2Owner 由以下内容实现

ProjectV2Owner 的字段

名称描述

id (ID!)

ProjectV2Owner 对象的节点 ID。

projectV2 (ProjectV2)

按编号查找项目。

projectV2 的参数

  • number (Int!)

    项目编号。

projectsV2 (ProjectV2Connection!)

所有者下项目的列表。

projectsV2 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • query (String)

    要在所有者下搜索的项目。

ProjectV2Recent

所有者的近期项目。

ProjectV2Recent 由以下内容实现

ProjectV2Recent 的字段

名称描述

recentProjects (ProjectV2Connection!)

此用户在所有者上下文中修改的近期项目。

recentProjects 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

Reactable

表示可以对其进行反应的主题。

Reactable 由以下内容实现

Reactable 的字段

名称描述

databaseId (Int)

标识数据库中的主键。

id (ID!)

Reactable 对象的节点 ID。

reactionGroups ([ReactionGroup!])

按主题上留下的内容分组的反应列表。

reactions (ReactionConnection!)

在 Issue 上留下的反应列表。

reactions 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

viewerCanReact (Boolean!)

用户是否可以对此主题做出反应。

RepositoryAuditEntryData

具有操作 repo.* 的审核条目的元数据。

RepositoryAuditEntryData 由以下内容实现

RepositoryAuditEntryData 的字段

名称描述

repository (Repository)

与操作关联的存储库。

repositoryName (String)

存储库的名称。

repositoryResourcePath (URI)

存储库的 HTTP 路径。

repositoryUrl (URI)

存储库的 HTTP URL。

RepositoryDiscussionAuthor

表示存储库中讨论的作者。

RepositoryDiscussionAuthor 由以下内容实现

RepositoryDiscussionAuthor 的字段

名称描述

repositoryDiscussions (DiscussionConnection!)

此用户启动的讨论。

repositoryDiscussions 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • answered (Boolean)

    将讨论过滤为仅那些已回复或未回复的讨论。默认情况下包括已回复和未回复的讨论。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • repositoryId (ID)

    将讨论过滤为仅特定存储库中的讨论。

RepositoryDiscussionCommentAuthor

表示存储库中讨论评论的作者。

RepositoryDiscussionCommentAuthor 由以下内容实现

RepositoryDiscussionCommentAuthor 的字段

名称描述

repositoryDiscussionComments (DiscussionCommentConnection!)

此用户创作的讨论评论。

repositoryDiscussionComments 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • onlyAnswers (Boolean)

    将讨论评论过滤为仅那些被标记为答案的评论。

    默认值为 false。

  • repositoryId (ID)

    将讨论评论过滤为仅特定存储库中的评论。

RepositoryInfo

存储库信息的一个子集。

RepositoryInfo 由以下内容实现

RepositoryInfo 的字段

名称描述

archivedAt (DateTime)

标识归档存储库的日期和时间。

createdAt (DateTime!)

标识对象创建的日期和时间。

description (String)

存储库的描述。

descriptionHTML (HTML!)

渲染为 HTML 的存储库的描述。

forkCount (Int!)

返回整个网络中此存储库的分叉数。

hasDiscussionsEnabled (Boolean!)

指示存储库是否启用了讨论功能。

hasIssuesEnabled (Boolean!)

指示存储库是否启用了问题功能。

hasProjectsEnabled (Boolean!)

指示存储库是否启用了项目功能。

hasSponsorshipsEnabled (Boolean!)

指示存储库是否显示赞助按钮以获取经济资助。

hasWikiEnabled (Boolean!)

指示仓库是否启用了 Wiki 功能。

homepageUrl (URI)

仓库的 URL。

isArchived (Boolean!)

指示仓库是否不再维护。

isFork (Boolean!)

标识仓库是否为 fork。

isInOrganization (Boolean!)

指示仓库是否属于某个组织所有，或是否为组织仓库的私有 fork。

isLocked (Boolean!)

指示仓库是否已被锁定。

isMirror (Boolean!)

标识仓库是否为镜像。

isPrivate (Boolean!)

标识仓库是否为私有或内部仓库。

isTemplate (Boolean!)

标识仓库是否为模板，可用于生成新的仓库。

licenseInfo (License)

与仓库关联的许可证。

lockReason (RepositoryLockReason)

仓库被锁定的原因。

mirrorUrl (URI)

仓库的原始镜像 URL。

name (String!)

存储库的名称。

nameWithOwner (String!)

包含所有者名称的仓库名称。

openGraphImageUrl (URI!)

在 Open Graph 数据中用于表示此仓库的图像。

owner (RepositoryOwner!)

仓库的用户所有者。

pushedAt (DateTime)

标识上次向仓库推送代码的日期和时间。

resourcePath (URI!)

此仓库的 HTTP 路径。

shortDescriptionHTML (HTML!)

仓库的描述，渲染为 HTML，不包含任何链接。

shortDescriptionHTML 的参数

  • limit (Int)

    返回的字符数。

    默认值为 200。

updatedAt (DateTime!)

标识对象上次更新的日期和时间。

url (URI!)

此仓库的 HTTP URL。

usesCustomOpenGraphImage (Boolean!)

此仓库是否具有自定义图像用于 Open Graph，而不是由所有者的头像表示。

visibility (RepositoryVisibility!)

指示仓库的可见性级别。

RepositoryOwner

表示仓库的所有者。

RepositoryOwner 由以下实现

RepositoryOwner 的字段

名称描述

avatarUrl (URI!)

指向所有者公开头像的 URL。

avatarUrl 的参数

  • size (Int)

    生成的正方形图像的大小。

id (ID!)

RepositoryOwner 对象的节点 ID。

login (String!)

用于登录的用户名。

repositories (RepositoryConnection!)

用户拥有的仓库列表。

repositories 的参数

  • affiliations ([RepositoryAffiliation])

    从连接中返回的仓库的查看者关联选项数组。例如，OWNER 将仅包含当前查看者拥有的仓库。

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • hasIssuesEnabled (Boolean)

    如果非空，则根据仓库是否启用了问题进行筛选。

  • isArchived (Boolean)

    如果非空，则根据仓库是否已归档且不再维护进行筛选。

  • isFork (Boolean)

    如果非空，则根据仓库是否为另一个仓库的 fork 进行筛选。

  • isLocked (Boolean)

    如果非空，则根据仓库是否已被锁定进行筛选。

  • last (Int)

    返回列表中的最后 n 个元素。

  • ownerAffiliations ([RepositoryAffiliation])

    从连接中返回的仓库的所有者关联选项数组。例如，OWNER 将仅包含正在查看的组织或用户拥有的仓库。

  • privacy (RepositoryPrivacy)

    如果非空，则根据隐私筛选仓库。内部仓库被视为私有仓库；如果只需要内部仓库，请考虑使用 visibility 参数。不能与 visibility 参数组合使用。

  • visibility (RepositoryVisibility)

    如果非空，则根据可见性筛选仓库。不能与 privacy 参数组合使用。

repository (Repository)

查找仓库。

repository 的参数

  • followRenames (Boolean)

    跟踪仓库重命名。如果禁用，则通过旧名称引用的仓库将返回错误。

    默认值为 true。

  • name (String!)

    要查找的仓库的名称。

resourcePath (URI!)

所有者的 HTTP URL。

url (URI!)

所有者的 HTTP URL。

RequirableByPullRequest

表示可以由拉取请求合并所需的类型。

RequirableByPullRequest 由以下实现

RequirableByPullRequest 的字段

名称描述

isRequired (Boolean!)

对于特定拉取请求，是否需要在合并之前通过此项。

isRequired 的参数

  • pullRequestId (ID)

    此项所需的拉取请求的 ID。

  • pullRequestNumber (Int)

    此项所需的拉取请求的编号。

Sponsorable

可以通过 GitHub Sponsors 赞助或被赞助的实体。

Sponsorable 由以下实现

Sponsorable 的字段

名称描述

estimatedNextSponsorsPayoutInCents (Int!)

此用户/组织的下一个 GitHub Sponsors 预计支付金额（以美分计）。

hasSponsorsListing (Boolean!)

如果此用户/组织有 GitHub Sponsors 列表，则为 True。

isSponsoredBy (Boolean!)

给定帐户是否正在赞助此用户/组织。

isSponsoredBy 的参数

  • accountLogin (String!)

    目标帐户的登录名。

isSponsoringViewer (Boolean!)

如果查看者由此用户/组织赞助，则为 True。

lifetimeReceivedSponsorshipValues (SponsorAndLifetimeValueConnection!)

计算每个赞助者通过 GitHub Sponsors 向此维护者支付的总金额。不包括通过 Patreon 支付的赞助。

lifetimeReceivedSponsorshipValues 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

monthlyEstimatedSponsorsIncomeInCents (Int!)

此用户/组织的每月预计 GitHub Sponsors 收入（以美分计）。

sponsoring (SponsorConnection!)

此实体正在赞助的用户和组织列表。

sponsoring 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • orderBy (SponsorOrder)

    从连接中返回的用户和组织的排序选项。

sponsors (SponsorConnection!)

此用户或组织的赞助者列表。

sponsors 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • orderBy (SponsorOrder)

    从连接中返回的赞助者的排序选项。

  • tierId (ID)

    如果给出，则将筛选给定层级的赞助者。仅返回查看者有权查看其层级的赞助者。

sponsorsActivities (SponsorsActivityConnection!)

涉及此可赞助实体的事件，例如新的赞助。

sponsorsActivities 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • includeAsSponsor (Boolean)

    是否包含此可赞助实体作为赞助者的事件。默认为仅包含此可赞助实体为赞助接收方的事件。

    默认值为 false。

  • includePrivate (Boolean)

    是否在结果集中包含私有活动。默认为包含公开和私有活动。

    默认值为 true。

  • last (Int)

    返回列表中的最后 n 个元素。

  • period (SponsorsActivityPeriod)

    过滤返回的活动，仅保留在最近指定的时间段内发生的活动。设置为 ALL 以避免按活动发生时间进行过滤。如果提供了 since 或 until，则将被忽略。

    默认值为 MONTH。

  • since (DateTime)

    过滤活动，仅保留在该时间或之后发生的活动。

  • until (DateTime)

    过滤活动，仅保留在该时间之前发生的活动。

sponsorsListing (SponsorsListing)

此用户或组织的 GitHub Sponsors 列表。

sponsorshipForViewerAsSponsor (Sponsorship)

查看者对该用户/组织的赞助；即，您作为赞助人的赞助。

sponsorshipForViewerAsSponsor 的参数

  • activeOnly (Boolean)

    是否仅在赞助仍然有效时返回赞助。传递 false 以获取查看者的赞助，即使它已被取消。

    默认值为 true。

sponsorshipForViewerAsSponsorable (Sponsorship)

该用户/组织对查看者的赞助；即，您收到的赞助。

sponsorshipForViewerAsSponsorable 的参数

  • activeOnly (Boolean)

    是否仅在赞助仍然有效时返回赞助。传递 false 以获取赞助，即使它已被取消。

    默认值为 true。

sponsorshipNewsletters (SponsorshipNewsletterConnection!)

从该可赞助对象发送给赞助商的赞助更新列表。

sponsorshipNewsletters 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

sponsorshipsAsMaintainer (SponsorshipConnection!)

此用户或组织作为接收资金的维护者所获得的赞助。

sponsorshipsAsMaintainer 的参数

  • activeOnly (Boolean)

    是否仅包含当前有效的赞助，而不是此维护者曾经收到的所有赞助。

    默认值为 true。

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • includePrivate (Boolean)

    是否在结果集中包含私有赞助。

    默认值为 false。

  • last (Int)

    返回列表中的最后 n 个元素。

  • orderBy (SponsorshipOrder)

    从此连接返回的赞助的排序选项。如果留空，则赞助将根据与查看者的相关性进行排序。

sponsorshipsAsSponsor (SponsorshipConnection!)

此用户或组织作为出资者所提供的赞助。

sponsorshipsAsSponsor 的参数

  • activeOnly (Boolean)

    是否仅包含当前有效的赞助，而不是此赞助者曾经提供的所有赞助。

    默认值为 true。

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

  • maintainerLogins ([String!])

    过滤返回的赞助，仅保留指定维护者的赞助。也就是说，赞助的接收者是具有给定登录名之一的用户或组织。

  • orderBy (SponsorshipOrder)

    从此连接返回的赞助的排序选项。如果留空，则赞助将根据与查看者的相关性进行排序。

totalSponsorshipAmountAsSponsorInCents (Int)

此实体在 GitHub 上用于资助赞助的支出金额（以美分计，例如 500 = 5.00 美元）。仅当由用户自己或可以管理请求组织的赞助的用户查看时才会返回值。

totalSponsorshipAmountAsSponsorInCents 的参数

  • since (DateTime)

    过滤付款，仅保留在该时间或之后发生的付款。

  • sponsorableLogins ([String!])

    过滤付款，仅保留支付给具有指定用户名的用户或组织的付款。

  • until (DateTime)

    过滤付款，仅保留在该时间之前发生的付款。

viewerCanSponsor (Boolean!)

查看者是否能够赞助此用户/组织。

viewerIsSponsoring (Boolean!)

如果查看者正在赞助此用户/组织，则为 true。

可加星标

可以加星标的事物。

Starrable 由以下对象实现

Starrable 的字段

名称描述

id (ID!)

可加星标对象的节点 ID。

stargazerCount (Int!)

返回此对象上的关注者数量。

stargazers (StargazerConnection!)

已为该可加星标对象加星标的用户列表。

stargazers 的参数

  • after (String)

    返回列表中指定游标之后的元素。

  • before (String)

    返回列表中指定游标之前的元素。

  • first (Int)

    返回列表中的前 n 个元素。

  • last (Int)

    返回列表中的最后 n 个元素。

viewerHasStarred (Boolean!)

返回一个布尔值，指示查看用户是否已为该可加星标对象加星标。

可订阅

可以订阅以获取网络和电子邮件通知的实体。

Subscribable 由以下对象实现

Subscribable 的字段

名称描述

id (ID!)

可订阅对象的节点 ID。

viewerCanSubscribe (Boolean!)

检查查看者是否能够更改其对存储库的订阅状态。

viewerSubscription (SubscriptionState)

标识查看者是否正在关注、未关注或忽略可订阅实体。

可订阅线程

可以订阅以获取网络和电子邮件通知的实体。

SubscribableThread 由以下对象实现

SubscribableThread 的字段

名称描述

id (ID!)

可订阅线程对象的节点 ID。

viewerThreadSubscriptionFormAction (ThreadSubscriptionFormAction)

标识查看者的线程订阅表单操作。

viewerThreadSubscriptionStatus (ThreadSubscriptionState)

标识查看者的线程订阅状态。

团队审计条目数据

具有操作 team.* 的审计条目的元数据。

TeamAuditEntryData 由以下对象实现

TeamAuditEntryData 的字段

名称描述

team (Team)

与操作关联的团队。

teamName (String)

团队的名称。

teamResourcePath (URI)

此团队的 HTTP 路径。

teamUrl (URI)

此团队的 HTTP URL。

主题审计条目数据

具有主题的审计条目的元数据。

TopicAuditEntryData 由以下对象实现

TopicAuditEntryData 的字段

名称描述

topic (Topic)

添加到存储库的主题的名称。

topicName (String)

添加到存储库的主题的名称。

可更新

可以更新的实体。

Updatable 由以下对象实现

Updatable 的字段

名称描述

viewerCanUpdate (Boolean!)

检查当前查看者是否可以更新此对象。

可更新评论

可以更新的评论。

UpdatableComment 由以下对象实现

UpdatableComment 的字段

名称描述

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

当前查看者无法更新此评论的原因。

可投票

可以点赞的主题。

Votable 由以下对象实现

Votable 的字段

名称描述

upvoteCount (Int!)

此主题收到的点赞数。

viewerCanUpvote (Boolean!)

当前用户是否可以添加或删除对此主题的点赞。

viewerHasUpvoted (Boolean!)

当前用户是否已为此主题点赞。