interface SalesforceAuthProviderPluginManagerInterface in Salesforce Suite 5.0.x

Auth provider plugin manager interface.

Hierarchy

• interface \Drupal\Component\Plugin\PluginManagerInterface; interface \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface; interface \Drupal\Core\Cache\CacheableDependencyInterface; interface \Drupal\Component\Plugin\FallbackPluginManagerInterface
  • interface \Drupal\salesforce\SalesforceAuthProviderPluginManagerInterface

9 files declare their use of SalesforceAuthProviderPluginManagerInterface

Rest.php in modules/salesforce_push/src/Plugin/SalesforcePushQueueProcessor/Rest.php

RestClient.php in src/Rest/RestClient.php

SalesforceAuthSettings.php in src/Form/SalesforceAuthSettings.php

SalesforceCommandsBase.php in src/Commands/SalesforceCommandsBase.php

SalesforceMappingCommands.php in modules/salesforce_mapping/src/Commands/SalesforceMappingCommands.php

... See full list

File

src/SalesforceAuthProviderPluginManagerInterface.php, line 13

Namespace

Drupal\salesforce

interface SalesforceAuthProviderPluginManagerInterface extends PluginManagerInterface, CachedDiscoveryInterface, CacheableDependencyInterface, FallbackPluginManagerInterface {

  /**
   * All Salesforce auth providers.
   *
   * @return \Drupal\salesforce\Entity\SalesforceAuthConfig[]
   *   All auth provider plugins.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function getProviders();

  /**
   * TRUE if any auth providers are defined.
   *
   * @return bool
   *   TRUE if any auth providers are defined.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function hasProviders();

  /**
   * Get the active auth service provider, or null if it has not been assigned.
   *
   * @return \Drupal\salesforce\Entity\SalesforceAuthConfig|null
   *   The active service provider, or null if it has not been assigned.
   */
  public function getConfig();

  /**
   * The auth provider plugin of the active service provider, or null.
   *
   * @return \Drupal\salesforce\SalesforceAuthProviderInterface|null
   *   The auth provider plugin of the active service provider, or null.
   */
  public function getProvider();

  /**
   * The credentials for the active auth provider plugin, or null.
   *
   * @return \Drupal\salesforce\Consumer\SalesforceCredentialsInterface|null
   *   The credentials for the active auth provider plugin, or null.
   */
  public function getCredentials();

  /**
   * Get the active token, or null if it has not been assigned.
   *
   * @return \OAuth\OAuth2\Token\TokenInterface|null
   *   The token of the plugin of the active config, or null.
   */
  public function getToken();

  /**
   * Force a refresh of the active token and return the fresh token.
   *
   * @return \OAuth\Common\Token\TokenInterface
   *   The token.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   * @throws \OAuth\OAuth2\Service\Exception\MissingRefreshTokenException
   */
  public function refreshToken();

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
CachedDiscoveryInterface::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches.	1
CachedDiscoveryInterface::useCaches	public	function	Disable the use of caches.	1
DiscoveryInterface::getDefinition	public	function	Gets a specific plugin definition.	4
DiscoveryInterface::getDefinitions	public	function	Gets the definition of all plugins for this type.	3
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	1
FactoryInterface::createInstance	public	function	Creates a pre-configured instance of a plugin.	6
FallbackPluginManagerInterface::getFallbackPluginId	public	function	Gets a fallback id for a missing plugin.	5
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	3
SalesforceAuthProviderPluginManagerInterface::getConfig	public	function	Get the active auth service provider, or null if it has not been assigned.	1
SalesforceAuthProviderPluginManagerInterface::getCredentials	public	function	The credentials for the active auth provider plugin, or null.	1
SalesforceAuthProviderPluginManagerInterface::getProvider	public	function	The auth provider plugin of the active service provider, or null.	1
SalesforceAuthProviderPluginManagerInterface::getProviders	public	function	All Salesforce auth providers.	1
SalesforceAuthProviderPluginManagerInterface::getToken	public	function	Get the active token, or null if it has not been assigned.	1
SalesforceAuthProviderPluginManagerInterface::hasProviders	public	function	TRUE if any auth providers are defined.	1
SalesforceAuthProviderPluginManagerInterface::refreshToken	public	function	Force a refresh of the active token and return the fresh token.	1