interface SalesforceOAuthPluginInterface in Salesforce Suite 8.3

OAuth user-agent plugin interface.

OAuth user-agent flow requires a 2-part handshake to complete authentication. This interface exposes methods to make the handshake possible.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\salesforce\SalesforceAuthProviderPluginInterface
    • interface \Drupal\salesforce\SalesforceOAuthPluginInterface

File

src/SalesforceOAuthPluginInterface.php, line 11

Namespace

Drupal\salesforce

interface SalesforceOAuthPluginInterface extends SalesforceAuthProviderPluginInterface {

  /**
   * Complete the OAuth user-agent handshake.
   *
   * @return bool
   *   TRUE if oauth finalization was successful.
   *
   * @throws \OAuth\Common\Http\Exception\TokenResponseException
   *
   * @see \Drupal\salesforce\Controller\SalesforceOAuthController
   */
  public function finalizeOauth();

  /**
   * Getter for consumer secret.
   *
   * @return string
   *   The consumer secret.
   */
  public function getConsumerSecret();

}

Members

Name	Modifiers	Type	Description	Overrides
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
SalesforceAuthProviderPluginInterface::getLoginUrl	public	function	Login URL set for this auth provider.
SalesforceAuthProviderPluginInterface::service	public	function	The auth provider service.
SalesforceOAuthPluginInterface::finalizeOauth	public	function	Complete the OAuth user-agent handshake.
SalesforceOAuthPluginInterface::getConsumerSecret	public	function	Getter for consumer secret.