com.adobe.cq.commerce.magento.graphql

Class __DirectiveQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<__DirectiveQuery>

com.adobe.cq.commerce.magento.graphql.__DirectiveQuery

public class __DirectiveQuery
extends AbstractQuery<__DirectiveQuery>

A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
__DirectiveQuery	addFragmentReference(Fragment<__DirectiveQuery> fragment) Adds a __DirectiveQuery fragment reference at the current position of the query.
__DirectiveQuery	args(__InputValueQueryDefinition queryDef)
static Fragment<__DirectiveQuery>	createFragment(String name, __DirectiveQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
__DirectiveQuery	description()
__DirectiveQuery	locations()
__DirectiveQuery	name()
__DirectiveQuery	onField() Deprecated. Use `locations`.
__DirectiveQuery	onFragment() Deprecated. Use `locations`.
__DirectiveQuery	onOperation() Deprecated. Use `locations`.

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

args

public __DirectiveQuery args(__InputValueQueryDefinition queryDef)

description

public __DirectiveQuery description()

locations

public __DirectiveQuery locations()

name

public __DirectiveQuery name()

onField

@Deprecated
public __DirectiveQuery onField()

Deprecated. Use `locations`.

onFragment

@Deprecated
public __DirectiveQuery onFragment()

Deprecated. Use `locations`.

onOperation

@Deprecated
public __DirectiveQuery onOperation()

Deprecated. Use `locations`.

createFragment

public static Fragment<__DirectiveQuery> createFragment(String name,
                                                        __DirectiveQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public __DirectiveQuery addFragmentReference(Fragment<__DirectiveQuery> fragment)

Adds a __DirectiveQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.