abstract public function getAccountID()
Get a unique identifier associated with the identity. For most providers, this is an account ID.
The account ID needs to be unique within this adapter's configuration, such that <adapterKey, accountID> is globally unique and always identifies the same identity.
If the adapter was unable to authenticate an identity, it should return null.
| string|null | Unique account identifier, or `null` if authentication failed. |
abstract public function getAdapterType()
Get a string identifying this adapter, like "ldap". This string should be unique to the adapter class.
| string | Unique adapter identifier. |
abstract 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()
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. |