final public function getAccountIdentifiers()Inherited
wild |
protected function newAccountIdentifiers()
wild |
final protected function newAccountIdentifier($raw_identifier)Inherited
$raw_identifier |
wild |
public function getAccountID()Inherited
Get a unique identifier associated with the account.
This identifier should be permanent, immutable, and uniquely identify the account. If possible, it should be nonsensitive. For providers that have a GUID or PHID value for accounts, these are the best values to use.
You can implement newAccountIdentifiers() instead if a provider is unable to emit identifiers with all of these properties.
If the adapter was unable to authenticate an identity, it should return null.
string|null | Unique account identifier, or `null` if authentication failed. |
public function getAdapterType()
Get a string identifying this adapter, like "ldap". This string should be unique to the adapter class.
string | Unique adapter identifier. |
public function getAdapterDomain()
Get a string identifying the domain this adapter is acting on. This allows an adapter (like LDAP) to act against different identity domains without conflating credentials. For providers like Facebook or Google, the adapters just return the relevant domain name.
string | Domain the adapter is associated with. |
public function getAdapterKey()Inherited
Generate a string uniquely identifying this adapter configuration. Within the scope of a given key, all account IDs must uniquely identify exactly one identity.
string | Unique identifier for this adapter configuration. |
public function getAccountEmail()
Optionally, return an email address associated with this account.
string|null | An email address associated with the account, or `null` if data is not available. |
public function getAccountName()
Optionally, return a human readable username associated with this account.
string|null | Account username, or `null` if data isn't available. |
public function getAccountURI()
Optionally, return a URI corresponding to a human-viewable profile for this account.
string|null | A profile URI associated with this account, or `null` if the data isn't available. |
public function getAccountImageURI()
Optionally, return a profile image URI associated with this account.
string|null | URI for an account profile image, or `null` if one is not available. |
public function getAccountRealName()
Optionally, return a real name associated with this account.
string|null | A human real name, or `null` if this data is not available. |
protected function getAuthenticateBaseURI()
wild |
protected function getTokenBaseURI()
wild |
protected function loadOAuthAccountData()
wild |
public function getAuthenticateURI()Inherited
wild |
public function setState($state)Inherited
$state |
wild |
public function getState()Inherited
wild |
public function setCode($code)Inherited
$code |
wild |
public function getCode()Inherited
wild |
public function setRedirectURI($redirect_uri)Inherited
$redirect_uri |
wild |
public function getRedirectURI()Inherited
wild |
public function getExtraAuthenticateParameters()
wild |
public function getExtraTokenParameters()
wild |
public function getExtraRefreshParameters()Inherited
wild |
public function setScope($scope)Inherited
$scope |
wild |
public function getScope()
wild |
public function setClientSecret($client_secret)Inherited
PhutilOpaqueEnvelope | $client_secret |
wild |
public function getClientSecret()Inherited
wild |
public function setClientID($client_id)Inherited
$client_id |
wild |
public function getClientID()Inherited
wild |
public function getAccessToken()Inherited
wild |
public function getAccessTokenExpires()Inherited
wild |
public function getRefreshToken()Inherited
wild |
protected function getAccessTokenData($key, $default)Inherited
$key | ||
$default |
wild |
public function supportsTokenRefresh()Inherited
wild |
public function refreshAccessToken($refresh_token)Inherited
$refresh_token |
wild |
protected function loadRefreshTokenData($refresh_token)Inherited
$refresh_token |
wild |
protected function loadAccessTokenData()Inherited
wild |
private function makeTokenRequest($params)Inherited
array | $params |
wild |
protected function readAccessTokenResponse($body)Inherited
$body |
wild |
protected function getOAuthAccountData($key, $default)Inherited
$key | ||
$default |
wild |