public function RelayMutationInputInterface::getClientMutationId in Open Social 10.1.x

Same name and namespace in other branches

1. 10.3.x modules/custom/social_graphql/src/Wrappers/RelayMutationInputInterface.php \Drupal\social_graphql\Wrappers\RelayMutationInputInterface::getClientMutationId()
2. 10.0.x modules/custom/social_graphql/src/Wrappers/RelayMutationInputInterface.php \Drupal\social_graphql\Wrappers\RelayMutationInputInterface::getClientMutationId()
3. 10.2.x modules/custom/social_graphql/src/Wrappers/RelayMutationInputInterface.php \Drupal\social_graphql\Wrappers\RelayMutationInputInterface::getClientMutationId()

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 value

string The unique mutation identifier.

File

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

Class

RelayMutationInputInterface

Mutation input conforming to the Relay specification.

Namespace

Drupal\social_graphql\Wrappers

Code

public function getClientMutationId() : ?string;