Interfaces

Interfaces serve as parent objects from which other objects can inherit.

About interfaces

Interfaces serve as parent objects from which other objects can inherit.

For example, Lockable is an interface because both Issue and PullRequest objects can be locked. An interface has its own list of named fields that are shared by implementing objects.

For more information, see Introduction to GraphQL.

Actor

An actor is an entity that can perform actions and own content within Open Social.

Actor implements

Fields for Actor

NameDescription
id (ID!)

The uuid of the Actor

displayName (String!)

The display name of the actor.

Commentable

Things that can be commented on.

Fields for Commentable

NameDescription
comments (CommentConnection!)

Connection

A paginated set of results.

Fields for Connection

NameDescription
edges ([Edge!]!)

The edges of this connection.

nodes ([Node!]!)

The nodes of the edges of this connection.

Provides direct access to the nodes in case other edge information isn't needed.

pageInfo (PageInfo!)

Information to aid in pagination

Edge

An edge in a connection.

Provides the cursor to fetch data based on the position of the associated node. Specific edge implementations may provide more information about the relationship they represent.

Fields for Edge

NameDescription
cursor (Cursor!)
node (Node!)

Media

Media managed by the Open Social platform.

Media implements

Fields for Media

NameDescription
id (ID!)
url (Url!)

The url at which the original media can be downloaded.

Node

A concrete fetchable type that is addressable by an id.

Fields for Node

NameDescription
id (ID!)

Response

The base GraphQL Response class

Fields for Response

NameDescription
errors ([Violation])