Nextcloud PHP API (master)

ISearchableReferenceProvider extends IDiscoverableReferenceProvider

Tags
since
26.0.0

Table of Contents

Methods

getCacheKey()  : string|null
Return a custom cache key to be used for caching the metadata This could be for example the current user id if the reference access permissions are different for each user
getCachePrefix()  : string
Return true if the reference metadata can be globally cached
getIconUrl()  : string
getId()  : string
getOrder()  : int
getSupportedSearchProviderIds()  : array<string|int, string>
getTitle()  : string
jsonSerialize()  : array<string|int, mixed>
matchReference()  : bool
Validate that a given reference identifier matches the current provider
resolveReference()  : IReference|null
Return a reference with its metadata for a given reference identifier

Methods

getCacheKey()

Return a custom cache key to be used for caching the metadata This could be for example the current user id if the reference access permissions are different for each user

public getCacheKey(string $referenceId) : string|null

Should return null, if the cache is only related to the reference id and has no further dependency

Parameters
$referenceId : string
Tags
since
25.0.0
Return values
string|null

getCachePrefix()

Return true if the reference metadata can be globally cached

public getCachePrefix(string $referenceId) : string
Parameters
$referenceId : string
Tags
since
25.0.0
Return values
string

getIconUrl()

public getIconUrl() : string
Tags
since
26.0.0
Return values
string

url to an icon that can be displayed next to the reference provider title

getSupportedSearchProviderIds()

public getSupportedSearchProviderIds() : array<string|int, string>
Tags
since
26.0.0
Return values
array<string|int, string>

list of search provider IDs that can be used by the vue-richtext picker

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
since
26.0.0
Return values
array<string|int, mixed>

representation of the provider

matchReference()

Validate that a given reference identifier matches the current provider

public matchReference(string $referenceText) : bool
Parameters
$referenceText : string
Tags
since
25.0.0
Return values
bool

resolveReference()

Return a reference with its metadata for a given reference identifier

public resolveReference(string $referenceText) : IReference|null
Parameters
$referenceText : string
Tags
since
25.0.0
Return values
IReference|null

        
On this page

Search results