Nextcloud PHP API (master)

IProviderWithUserId extends IProvider

This interface allows providers to access the user that initiated the task being run.

Tags
since
28.0.0
template

T of ITaskType

template-extends

IProvider<T>

Table of Contents

Methods

getName()  : string
The localized name of this provider
getTaskType()  : T>
Returns the task type class string of the task type, that this provider handles
process()  : string
Processes a text
setUserId()  : void

Methods

getName()

The localized name of this provider

public getName() : string
Tags
since
27.1.0
Return values
string

getTaskType()

Returns the task type class string of the task type, that this provider handles

public getTaskType() : T>
Tags
since
27.1.0
Return values
T>

process()

Processes a text

public process(string $prompt) : string
Parameters
$prompt : string

The input text

Tags
since
27.1.0
throws
RuntimeException

If the text could not be processed

Return values
string

the output text

setUserId()

public setUserId(string|null $userId) : void
Parameters
$userId : string|null

the current user's id

Tags
since
28.0.0

        
On this page

Search results