interface ClientServiceInterface in Sparkpost email 8.2

Interface for the client service.

@package Drupal\sparkpost

Hierarchy

• interface \Drupal\sparkpost\ClientServiceInterface

1 file declares its use of ClientServiceInterface

QueuedMessageWrapper.php in modules/sparkpost_requeue/src/QueuedMessageWrapper.php

File

src/ClientServiceInterface.php, line 10

Namespace

Drupal\sparkpost

interface ClientServiceInterface {

  /**
   * Gets the client.
   *
   * @return \SparkPost\SparkPost
   *   The client.
   */
  public function getClient();

  /**
   * Sends the message.
   *
   * @param array $message
   *   The sparkpost message.
   *
   * @return array
   *   The body of the response.
   */
  public function sendMessage(array $message);

  /**
   * Sends the request.
   *
   * @param string $endpoint
   *   The endpoint to use.
   * @param array $data
   *   The data to send.
   * @param string $method
   *   The HTTP method to use.
   *
   * @return array
   *   The body of the response.
   */
  public function sendRequest($endpoint, array $data, $method = 'GET');

}

Members

Name	Modifiers	Type	Description	Overrides
ClientServiceInterface::getClient	public	function	Gets the client.	1
ClientServiceInterface::sendMessage	public	function	Sends the message.	1
ClientServiceInterface::sendRequest	public	function	Sends the request.	1