Discussões

Documentação de referência para tipos de esquema GraphQL na categoria Discussões.

Neste artigo

Mutations

addDiscussionComment

Mutation

Adds a comment to a Discussion, possibly as a reply to another comment.

Campos de entrada para addDiscussionComment

Campos de retorno para addDiscussionComment

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The newly created discussion comment.

addDiscussionPollVote

Mutation

Vote for an option in a discussion poll.

Campos de entrada para addDiscussionPollVote

Campos de retorno para addDiscussionPollVote

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

pollOption (DiscussionPollOption)

The poll option that a vote was added to.

addUpvote

Mutation

Add an upvote to a discussion or discussion comment.

Campos de entrada para addUpvote

Campos de retorno para addUpvote

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

closeDiscussion

Mutation

Close a discussion.

Campos de entrada para closeDiscussion

Campos de retorno para closeDiscussion

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was closed.

createDiscussion

Mutation

Create a discussion.

Campos de entrada para createDiscussion

Campos de retorno para createDiscussion

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just created.

deleteDiscussion

Mutation

Delete a discussion and all of its replies.

Campos de entrada para deleteDiscussion

Campos de retorno para deleteDiscussion

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was just deleted.

deleteDiscussionComment

Mutation

Delete a discussion comment. If it has replies, wipe it instead.

Campos de entrada para deleteDiscussionComment

Campos de retorno para deleteDiscussionComment

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The discussion comment that was just deleted.

markDiscussionCommentAsAnswer

Mutation

Mark a discussion comment as the chosen answer for discussions in an answerable category.

Campos de entrada para markDiscussionCommentAsAnswer

Campos de retorno para markDiscussionCommentAsAnswer

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the chosen comment.

removeUpvote

Mutation

Remove an upvote to a discussion or discussion comment.

Campos de entrada para removeUpvote

Campos de retorno para removeUpvote

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

subject (Votable)

The votable subject.

reopenDiscussion

Mutation

Reopen a discussion.

Campos de entrada para reopenDiscussion

Campos de retorno para reopenDiscussion

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that was reopened.

unmarkDiscussionCommentAsAnswer

Mutation

Unmark a discussion comment as the chosen answer for discussions in an answerable category.

Campos de entrada para unmarkDiscussionCommentAsAnswer

Campos de retorno para unmarkDiscussionCommentAsAnswer

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The discussion that includes the comment.

updateDiscussion

Mutation

Update a discussion.

Campos de entrada para updateDiscussion

Campos de retorno para updateDiscussion

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

discussion (Discussion)

The modified discussion.

updateDiscussionComment

Mutation

Update the contents of a comment on a Discussion.

Campos de entrada para updateDiscussionComment

Campos de retorno para updateDiscussionComment

NomeDescrição

clientMutationId (String)

A unique identifier for the client performing the mutation.

comment (DiscussionComment)

The modified discussion comment.

Objects

Discussion

Object

A discussion in a repository.

Discussion Implementa

Campos para Discussion

NomeDescrição

activeLockReason (LockReason)

Reason that the conversation was locked.

answer (DiscussionComment)

The comment chosen as this discussion's answer, if any.

answerChosenAt (DateTime)

The time when a user chose this discussion's answer, if answered.

answerChosenBy (Actor)

The user who chose this discussion's answer, if answered.

author (Actor)

The actor who authored the discussion.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The main text of the discussion post.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

category (DiscussionCategory!)

The category for this discussion.

closed (Boolean!)

Indicates if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.

comments (DiscussionCommentConnection!)

The replies to the discussion.

Argumentos para comments

  • 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.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

id (ID!)

The Node ID of the Discussion object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isAnswered (Boolean)

Only return answered/unanswered discussions.

labels (LabelConnection)

A list of labels associated with the object.

Argumentos para labels

  • 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.

  • orderBy (LabelOrder)

    Ordering options for labels returned from the connection.

lastEditedAt (DateTime)

The moment the editor made the last edit.

locked (Boolean!)

true if the object is locked.

number (Int!)

The number identifying this discussion within the repository.

poll (DiscussionPoll)

The poll associated with this discussion, if one exists.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Argumentos para reactions

  • 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.

  • orderBy (ReactionOrder)

    Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The path for this discussion.

stateReason (DiscussionStateReason)

Identifies the reason for the discussion's state.

title (String!)

The title of this discussion.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

upvoteCount (Int!)

Number of upvotes that this subject has received.

url (URI!)

The URL for this discussion.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Argumentos para userContentEdits

  • 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.

viewerCanClose (Boolean!)

Indicates if the object can be closed by the viewer.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanLabel (Boolean!)

Indicates if the viewer can edit labels for this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanReopen (Boolean!)

Indicates if the object can be reopened by the viewer.

viewerCanSubscribe (Boolean!)

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

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCanUpvote (Boolean!)

Whether or not the current user can add or remove an upvote on this subject.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerHasUpvoted (Boolean!)

Whether or not the current user has already upvoted this subject.

viewerSubscription (SubscriptionState)

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

DiscussionCategory

Object

A category for discussions in a repository.

DiscussionCategory Implementa

Campos para DiscussionCategory

NomeDescrição

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

A description of this category.

emoji (String!)

An emoji representing this category.

emojiHTML (HTML!)

This category's emoji rendered as HTML.

id (ID!)

The Node ID of the DiscussionCategory object.

isAnswerable (Boolean!)

Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.

name (String!)

The name of this category.

repository (Repository!)

The repository associated with this node.

slug (String!)

The slug of this category.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

DiscussionCategoryConnection

Object

The connection type for DiscussionCategory.

Campos para DiscussionCategoryConnection

NomeDescrição

edges ([DiscussionCategoryEdge])

A list of edges.

nodes ([DiscussionCategory])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

DiscussionCategoryEdge

Object

An edge in a connection.

Campos para DiscussionCategoryEdge

NomeDescrição

cursor (String!)

A cursor for use in pagination.

node (DiscussionCategory)

The item at the end of the edge.