Class Relay

java.lang.Object

graphql.relay.Relay

@PublicApi
@NullMarked
public class Relay
extends Object

This can be used to compose graphql runtime types that implement that Relay specification.

See https://relay.dev/graphql/connections.htm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Relay.ResolvedGlobalId

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NODE
static final GraphQLObjectType	pageInfoType

Constructor Summary

Constructors

Constructor	Description
Relay()

Method Summary

Modifier and Type	Method	Description
GraphQLObjectType	connectionType(String name, GraphQLObjectType edgeType, List<GraphQLFieldDefinition> connectionFields)
GraphQLObjectType	edgeType(String name, GraphQLOutputType nodeType, GraphQLInterfaceType nodeInterface, List<GraphQLFieldDefinition> edgeFields)
Relay.ResolvedGlobalId	fromGlobalId(String globalId)
List<GraphQLArgument>	getBackwardPaginationConnectionFieldArguments()
List<GraphQLArgument>	getConnectionFieldArguments()
List<GraphQLArgument>	getForwardPaginationConnectionFieldArguments()
GraphQLFieldDefinition	mutation(String name, String fieldName, List<GraphQLInputObjectField> inputFields, List<GraphQLFieldDefinition> outputFields, DataFetcher dataFetcher)
GraphQLFieldDefinition	mutationWithClientMutationId(String name, String fieldName, List<GraphQLInputObjectField> inputFields, List<GraphQLFieldDefinition> outputFields, DataFetcher dataFetcher)
GraphQLFieldDefinition	nodeField(GraphQLInterfaceType nodeInterface, DataFetcher nodeDataFetcher)
GraphQLInterfaceType	nodeInterface(TypeResolver typeResolver)
String	toGlobalId(String type, String id)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NODE

public static final String NODE

See Also:

• Constant Field Values

pageInfoType

public static final GraphQLObjectType pageInfoType

Constructor Details

Relay

public Relay()

Method Details

nodeInterface

public GraphQLInterfaceType nodeInterface(TypeResolver typeResolver)

nodeField

public GraphQLFieldDefinition nodeField(GraphQLInterfaceType nodeInterface,
 DataFetcher nodeDataFetcher)

getConnectionFieldArguments

public List<GraphQLArgument> getConnectionFieldArguments()

getBackwardPaginationConnectionFieldArguments

public List<GraphQLArgument> getBackwardPaginationConnectionFieldArguments()

getForwardPaginationConnectionFieldArguments

public List<GraphQLArgument> getForwardPaginationConnectionFieldArguments()

edgeType

public GraphQLObjectType edgeType(String name,
 GraphQLOutputType nodeType,
 GraphQLInterfaceType nodeInterface,
 List<GraphQLFieldDefinition> edgeFields)

connectionType

public GraphQLObjectType connectionType(String name,
 GraphQLObjectType edgeType,
 List<GraphQLFieldDefinition> connectionFields)

mutationWithClientMutationId

public GraphQLFieldDefinition mutationWithClientMutationId(String name,
 String fieldName,
 List<GraphQLInputObjectField> inputFields,
 List<GraphQLFieldDefinition> outputFields,
 DataFetcher dataFetcher)

mutation

public GraphQLFieldDefinition mutation(String name,
 String fieldName,
 List<GraphQLInputObjectField> inputFields,
 List<GraphQLFieldDefinition> outputFields,
 DataFetcher dataFetcher)

toGlobalId

public String toGlobalId(String type,
 String id)

fromGlobalId

public Relay.ResolvedGlobalId fromGlobalId(String globalId)