Nextcloud PHP API (stable18)

IMetadataProvider

Interface IMetadataProvider

Provider for metadata of a resource or a room

Tags
since
17.0.0

Table of Contents

getAllAvailableMetadataKeys()  : string[]
Get a list of all metadata keys available for this room
getMetadataForKey()  : string|null
Get the value for a metadata key
hasMetadataForKey()  : bool
Get whether or not a metadata key is set for this room

Methods

getAllAvailableMetadataKeys()

Get a list of all metadata keys available for this room

public getAllAvailableMetadataKeys() : string[]

Room backends are allowed to return custom keys, beyond the ones defined in this class. If they do, they should make sure to use their own namespace.

Tags
since
17.0.0
Return values
string[]
  • A list of available keys

getMetadataForKey()

Get the value for a metadata key

public getMetadataForKey(string $key) : string|null
Parameters
$key : string
  • The key to check for
Tags
since
17.0.0
Return values
string|null
  • The value stored for the key, null if no value stored

hasMetadataForKey()

Get whether or not a metadata key is set for this room

public hasMetadataForKey(string $key) : bool
Parameters
$key : string
  • The key to check for
Tags
since
17.0.0
Return values
bool
  • Whether or not key is available

Search results