You are here

interface SalesforceCredentialsInterface in Salesforce Suite 5.0.x

Same name and namespace in other branches
  1. 8.4 src/Consumer/SalesforceCredentialsInterface.php \Drupal\salesforce\Consumer\SalesforceCredentialsInterface
  2. 8.3 src/Consumer/SalesforceCredentialsInterface.php \Drupal\salesforce\Consumer\SalesforceCredentialsInterface

Salesforce credentials interface.

Hierarchy

Expanded class hierarchy of SalesforceCredentialsInterface

All classes that implement SalesforceCredentialsInterface

File

src/Consumer/SalesforceCredentialsInterface.php, line 8

Namespace

Drupal\salesforce\Consumer
View source
interface SalesforceCredentialsInterface {

  /**
   * Get the consumer key for these credentials.
   *
   * @return string
   *   The consumer key.
   */
  public function getConsumerKey();

  /**
   * Get the login URL for these credentials.
   *
   * @return string
   *   The login url, e.g. https://login.salesforce.com.
   */
  public function getLoginUrl();

  /**
   * Sanity check for credentials validity.
   *
   * @return bool
   *   TRUE if credentials are set properly. Otherwise false.
   */
  public function isValid();

  /**
   * Create helper.
   *
   * @param array $configuration
   *   Plugin configuration.
   *
   * @return static
   */
  public static function create(array $configuration);

}

Members

Namesort descending Modifiers Type Description Overrides
SalesforceCredentialsInterface::create public static function Create helper. 1
SalesforceCredentialsInterface::getConsumerKey public function Get the consumer key for these credentials. 1
SalesforceCredentialsInterface::getLoginUrl public function Get the login URL for these credentials. 1
SalesforceCredentialsInterface::isValid public function Sanity check for credentials validity. 1