Nextcloud PHP API (master)

Task
in package
implements JsonSerializable

FinalYes

This is a text to image task

Tags
since
28.0.0

Table of Contents

Interfaces

JsonSerializable

Constants

STATUS_FAILED  = 4
STATUS_RUNNING  = 2
STATUS_SCHEDULED  = 1
STATUS_SUCCESSFUL  = 3
STATUS_UNKNOWN  = 0

Properties

$appId  : string
$completionExpectedAt  : DateTime|null
$id  : int|null
$identifier  : string|null
$input  : string
$numberOfImages  : int
$status  : int
$userId  : string|null

Methods

__construct()  : mixed
getAppId()  : string
getCompletionExpectedAt()  : DateTime|null
getId()  : int|null
getIdentifier()  : null|string
getInput()  : string
getNumberOfImages()  : int
getOutputImages()  : array<string|int, IImage>|null
getStatus()  : int
getUserId()  : string|null
jsonSerialize()  : array<string|int, mixed>
setCompletionExpectedAt()  : void
setId()  : void
setStatus()  : void

Constants

STATUS_FAILED

public mixed STATUS_FAILED = 4
Tags
since
28.0.0

STATUS_RUNNING

public mixed STATUS_RUNNING = 2
Tags
since
28.0.0

STATUS_SCHEDULED

public mixed STATUS_SCHEDULED = 1
Tags
since
28.0.0

STATUS_SUCCESSFUL

public mixed STATUS_SUCCESSFUL = 3
Tags
since
28.0.0

STATUS_UNKNOWN

public mixed STATUS_UNKNOWN = 0
Tags
since
28.0.0

Properties

$appId

protected string $appId

$completionExpectedAt

protected DateTime|null $completionExpectedAt = null

$id

protected int|null $id = null

$identifier

protected string|null $identifier = ''

$input

protected string $input

$numberOfImages

protected int $numberOfImages

$status

protected int $status = self::STATUS_UNKNOWN
Tags
psalm-var

self::STATUS_*

$userId

protected string|null $userId

Methods

__construct()

public final __construct(string $input, string $appId, int $numberOfImages, string|null $userId[, null|string $identifier = '' ]) : mixed
Parameters
$input : string
$appId : string
$numberOfImages : int
$userId : string|null
$identifier : null|string = ''

An arbitrary identifier for this task. max length: 255 chars

Tags
since
28.0.0

getAppId()

public final getAppId() : string
Tags
since
28.0.0
Return values
string

getCompletionExpectedAt()

public final getCompletionExpectedAt() : DateTime|null
Tags
since
28.0.0
Return values
DateTime|null

getId()

public final getId() : int|null
Tags
since
28.0.0
Return values
int|null

getIdentifier()

public final getIdentifier() : null|string
Tags
since
28.0.0
Return values
null|string

getInput()

public final getInput() : string
Tags
since
28.0.0
Return values
string

getNumberOfImages()

public final getNumberOfImages() : int
Tags
since
28.0.0
Return values
int

getOutputImages()

public final getOutputImages() : array<string|int, IImage>|null
Tags
since
28.0.0
Return values
array<string|int, IImage>|null

getStatus()

public final getStatus() : int
Tags
psalm-return

self::STATUS_*

since
28.0.0
Return values
int

getUserId()

public final getUserId() : string|null
Tags
since
28.0.0
Return values
string|null

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
psalm-return

array{id: ?int, status: self::STATUS_*, userId: ?string, appId: string, input: string, identifier: ?string, numberOfImages: int, completionExpectedAt: ?int}

since
28.0.0
Return values
array<string|int, mixed>

setCompletionExpectedAt()

public final setCompletionExpectedAt(DateTime|null $at) : void
Parameters
$at : DateTime|null
Tags
since
28.0.0

setId()

public final setId(int|null $id) : void
Parameters
$id : int|null
Tags
since
28.0.0

setStatus()

public final setStatus(int $status) : void
Parameters
$status : int
Tags
psalm-param

self::STATUS_* $status

since
28.0.0 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results