IAccount extends JsonSerializable
Interface IAccount
Tags
Table of Contents
- getFilteredProperties() : \OCP\Accounts\IAccountProperty[]
- Get all properties that match the provided filters for scope and verification status
- getProperties() : \OCP\Accounts\IAccountProperty[]
- Get all properties of an account
- getProperty() : IAccountProperty
- Get a property by its key
- getUser() : IUser
- Get the related user for the account data
- setProperty() : IAccount
- Set a property with data
Methods
getFilteredProperties()
Get all properties that match the provided filters for scope and verification status
public
getFilteredProperties([string $scope = null ][, string $verified = null ]) : \OCP\Accounts\IAccountProperty[]
Parameters
- $scope : string = null
-
Must be one of the VISIBILITY_ prefixed constants of \OCP\Accounts\IAccountManager
- $verified : string = null
-
\OCP\Accounts\IAccountManager::NOT_VERIFIED | \OCP\Accounts\IAccountManager::VERIFICATION_IN_PROGRESS | \OCP\Accounts\IAccountManager::VERIFIED
Tags
Return values
\OCP\Accounts\IAccountProperty[] —getProperties()
Get all properties of an account
public
getProperties() : \OCP\Accounts\IAccountProperty[]
Tags
Return values
\OCP\Accounts\IAccountProperty[] —getProperty()
Get a property by its key
public
getProperty(string $property) : IAccountProperty
Parameters
- $property : string
-
Must be one of the PROPERTY_ prefixed constants of \OCP\Accounts\IAccountManager
Tags
Return values
IAccountProperty —getUser()
Get the related user for the account data
public
getUser() : IUser
Tags
Return values
IUser —setProperty()
Set a property with data
public
setProperty(string $property, string $value, string $scope, string $verified) : IAccount
Parameters
- $property : string
-
Must be one of the PROPERTY_ prefixed constants of \OCP\Accounts\IAccountManager
- $value : string
- $scope : string
-
Must be one of the VISIBILITY_ prefixed constants of \OCP\Accounts\IAccountManager
- $verified : string
-
\OCP\Accounts\IAccountManager::NOT_VERIFIED | \OCP\Accounts\IAccountManager::VERIFICATION_IN_PROGRESS | \OCP\Accounts\IAccountManager::VERIFIED