interface PayloadInterface in Open Social 10.0.x

Response interface used for GraphQL responses.

Hierarchy

• interface \Drupal\social_graphql\GraphQL\Payload\PayloadInterface

1 file declares its use of PayloadInterface

PayloadViolations.php in modules/custom/social_graphql/src/Plugin/GraphQL/DataProducer/Payload/PayloadViolations.php

File

modules/custom/social_graphql/src/GraphQL/Payload/PayloadInterface.php, line 12

Namespace

Drupal\social_graphql\GraphQL\Payload

interface PayloadInterface {

  /**
   * Adds the violation.
   *
   * @param \Drupal\social_graphql\GraphQL\ViolationInterface $violation
   *   A violation.
   *
   * @return \Drupal\social_graphql\GraphQL\Payload\PayloadInterface
   *   This response.
   */
  public function addViolation(ViolationInterface $violation) : self;

  /**
   * Adds multiple violations.
   *
   * @param array $violations
   *   An array of violations.
   *
   * @return \Drupal\social_graphql\GraphQL\Payload\PayloadInterface
   *   This response.
   */
  public function addViolations(array $violations) : self;

  /**
   * Gets the violations.
   *
   * @return \Drupal\social_graphql\GraphQL\ViolationInterface[]
   *   The Violations.
   */
  public function getViolations() : array;

}

Members

Name	Modifiers	Type	Description	Overrides
PayloadInterface::addViolation	public	function	Adds the violation.
PayloadInterface::addViolations	public	function	Adds multiple violations.
PayloadInterface::getViolations	public	function	Gets the violations.