Enterprise Server 3.21 目前作为发布候选版本提供。

Reference documentation for GraphQL schema types in the Activity category.

在本文中

Mutations

addStar

Mutation

Adds a star to a Starrable.

输入 addStar 字段

返回 addStar 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

removeStar

Mutation

Removes a star from a Starrable.

输入 removeStar 字段

返回 removeStar 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrable (Starrable)

The starrable.

updateNotificationRestrictionSetting

Mutation

Update the setting to restrict notifications to only verified or approved domains available to an owner.

输入 updateNotificationRestrictionSetting 字段

返回 updateNotificationRestrictionSetting 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (VerifiableDomainOwner)

The owner on which the setting was updated.

updateSubscription

Mutation

Updates the state for subscribable subjects.

输入 updateSubscription 字段

返回 updateSubscription 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

subscribable (Subscribable)

The input subscribable entity.

Interfaces

Starrable

Interface

Things that can be starred.

Starrable 的实现方式

Starrable 字段

名称说明

id (ID!)

The Node ID of the Starrable object.

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

stargazers 的参数

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

Subscribable

Interface

Entities that can be subscribed to for web and email notifications.

Subscribable 的实现方式

Subscribable 字段

名称说明

id (ID!)

The Node ID of the Subscribable object.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

SubscribableThread

Interface

Entities that can be subscribed to for web and email notifications.

SubscribableThread 的实现方式

SubscribableThread 字段

名称说明

id (ID!)

The Node ID of the SubscribableThread object.

viewerThreadSubscriptionFormAction (ThreadSubscriptionFormAction)

Identifies the viewer's thread subscription form action.

viewerThreadSubscriptionStatus (ThreadSubscriptionState)

Identifies the viewer's thread subscription status.

Enums

NotificationRestrictionSettingValue

Enum

The possible values for the notification restriction setting.

NotificationRestrictionSettingValue 的值

名称说明
DISABLED

The setting is disabled for the owner.

ENABLED

The setting is enabled for the owner.

StarOrderField

Enum

Properties by which star connections can be ordered.

StarOrderField 的值

名称说明
STARRED_AT

Allows ordering a list of stars by when they were created.

SubscriptionState

Enum

The possible states of a subscription.

SubscriptionState 的值

名称说明
IGNORED

The User is never notified.

SUBSCRIBED

The User is notified of all conversations.

UNSUBSCRIBED

The User is only notified when participating or @mentioned.

ThreadSubscriptionFormAction

Enum

The possible states of a thread subscription form action.

ThreadSubscriptionFormAction 的值

名称说明
NONE

The User cannot subscribe or unsubscribe to the thread.

SUBSCRIBE

The User can subscribe to the thread.

UNSUBSCRIBE

The User can unsubscribe to the thread.

ThreadSubscriptionState

Enum

The possible states of a subscription.

ThreadSubscriptionState 的值

名称说明
DISABLED

The subscription status is currently disabled.

IGNORING_LIST

The User is never notified because they are ignoring the list.

IGNORING_THREAD

The User is never notified because they are ignoring the thread.

NONE

The User is not recieving notifications from this thread.

SUBSCRIBED_TO_LIST

The User is notified becuase they are watching the list.

SUBSCRIBED_TO_THREAD

The User is notified because they are subscribed to the thread.

SUBSCRIBED_TO_THREAD_EVENTS

The User is notified because they chose custom settings for this thread.

SUBSCRIBED_TO_THREAD_TYPE

The User is notified because they chose custom settings for this thread.

UNAVAILABLE

The subscription status is currently unavailable.

Input objects

AddStarInput

Input object

Autogenerated input type of AddStar.

输入 AddStarInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to star.

RemoveStarInput

Input object

Autogenerated input type of RemoveStar.

输入 RemoveStarInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

starrableId (ID!)

The Starrable ID to unstar.

StarOrder

Input object

Ways in which star connections can be ordered.

输入 StarOrder 字段

名称说明

direction (OrderDirection!)

The direction in which to order nodes.

field (StarOrderField!)

The field in which to order nodes by.

UpdateNotificationRestrictionSettingInput

Input object

Autogenerated input type of UpdateNotificationRestrictionSetting.

输入 UpdateNotificationRestrictionSettingInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

ownerId (ID!)

The ID of the owner on which to set the restrict notifications setting.

settingValue (NotificationRestrictionSettingValue!)

The value for the restrict notifications setting.

UpdateSubscriptionInput

Input object

Autogenerated input type of UpdateSubscription.

输入 UpdateSubscriptionInput 字段

名称说明

clientMutationId (String)

A unique identifier for the client performing the mutation.

state (SubscriptionState!)

The new state of the subscription.

subscribableId (ID!)

The Node ID of the subscribable object to modify.