You are here

interface RelayMutationInputInterface in Open Social 10.3.x

Same name and namespace in other branches
  1. 10.0.x modules/custom/social_graphql/src/Wrappers/RelayMutationInputInterface.php \Drupal\social_graphql\Wrappers\RelayMutationInputInterface
  2. 10.1.x modules/custom/social_graphql/src/Wrappers/RelayMutationInputInterface.php \Drupal\social_graphql\Wrappers\RelayMutationInputInterface
  3. 10.2.x modules/custom/social_graphql/src/Wrappers/RelayMutationInputInterface.php \Drupal\social_graphql\Wrappers\RelayMutationInputInterface

Mutation input conforming to the Relay specification.

Hierarchy

Expanded class hierarchy of RelayMutationInputInterface

All classes that implement RelayMutationInputInterface

File

modules/custom/social_graphql/src/Wrappers/RelayMutationInputInterface.php, line 10

Namespace

Drupal\social_graphql\Wrappers
View source
interface RelayMutationInputInterface extends InputInterface {

  /**
   * Get the identifier for this mutation provided by the client.
   *
   * When provided, should be included in the payload for the mutation. This
   * allows a client to match up mutations with responses (for example in case
   * of optimistic updates) regardless of transport method.
   *
   * Mutation DataProducers can use this to ensure mutations are idempotent by
   * caching the result of a mutation and returning the same response if a
   * clientMutationId is repeated. This makes it possible for clients to safely
   * retry operations such as sending messages.
   *
   * @return string
   *   The unique mutation identifier.
   */
  public function getClientMutationId() : ?string;

}

Members

Namesort descending Modifiers Type Description Overrides
InputInterface::getViolations public function Get the violations on this input.
InputInterface::hasViolations public function Whether this input has any violations.
InputInterface::setValues public function Set the values for this input.
InputInterface::validate public function Validates the input.
RelayMutationInputInterface::getClientMutationId public function Get the identifier for this mutation provided by the client.