IAccount

interface OCP\Accounts\IAccount
Interface IAccount
Implemented by:OC\Accounts\Account
Source:lib/public/Accounts/IAccount.php#36
Parent:JsonSerializable

Methods

public OCP\Accounts\IAccount::setProperty($property, $value, $scope, $verified)
Set a property with data
Source:

lib/public/Accounts/IAccount.php#49

Parameters:
  • $property (string) Must be one of the PROPERTY_ prefixed constants of OCPAccountsIAccountManager
  • $value (string)
  • $scope (string) Must be one of the VISIBILITY_ prefixed constants of OCPAccountsIAccountManager
  • $verified (string) OCPAccountsIAccountManager::NOT_VERIFIED | OCPAccountsIAccountManager::VERIFICATION_IN_PROGRESS | OCPAccountsIAccountManager::VERIFIED
Since:

15.0.0

Returns:

\OCP\Accounts\IAccount

public OCP\Accounts\IAccount::getProperty($property)
Get a property by its key
Source:

lib/public/Accounts/IAccount.php#60

Parameters:
  • $property (string) Must be one of the PROPERTY_ prefixed constants of OCPAccountsIAccountManager
Since:

15.0.0

Returns:

\OCP\Accounts\IAccountProperty

Throws:

\OCP\Accounts\PropertyDoesNotExistException

public OCP\Accounts\IAccount::getProperties()
Get all properties of an account
Source:lib/public/Accounts/IAccount.php#69
Since:15.0.0
Returns:\OCP\Accounts\IAccountProperty[]
public OCP\Accounts\IAccount::getFilteredProperties($scope=null, $verified=null)
Get all properties that match the provided filters for scope and verification status
Source:

lib/public/Accounts/IAccount.php#80

Parameters:
  • $scope (string) Must be one of the VISIBILITY_ prefixed constants of OCPAccountsIAccountManager
  • $verified (string) OCPAccountsIAccountManager::NOT_VERIFIED | OCPAccountsIAccountManager::VERIFICATION_IN_PROGRESS | OCPAccountsIAccountManager::VERIFIED
Since:

15.0.0

Returns:

\OCP\Accounts\IAccountProperty[]

public OCP\Accounts\IAccount::getUser()
Get the related user for the account data
Source:lib/public/Accounts/IAccount.php#89
Since:15.0.0
Returns:\OCP\IUser