Bitrix API

Result extends Result implements JsonSerializable

FinalYes
Tags
template

Table of Contents

Interfaces

JsonSerializable

Constants

ALL_OPERATION_STATUSES  = [self::OPERATION_STATUS_CONFLICT, self::OPERATION_STATUS_APPLIED, self::OPERATION_STATUS_REJECTED]
MAX_RETRY_COUNT  = 1
OPERATION_STATUS_APPLIED  = 'APPLIED'
OPERATION_STATUS_CONFLICT  = 'CONFLICT'
OPERATION_STATUS_REJECTED  = 'REJECTED'

Methods

__clone()  : mixed
__construct()  : mixed
getJobId()  : int|null
getLanguageId()  : string|null
getNextTypeId()  : int|null
getOperationStatus()  : string|null
getParentJobId()  : int|null
getPayload()  : T|null
getRetryCount()  : int|null
getTarget()  : ItemIdentifier|null
getTypeId()  : int
getUserId()  : int|null
isErrorsLimitExceeded()  : bool
isFinalOperationStatus()  : bool
isInFinalOperationStatus()  : bool
isManualLaunch()  : bool
isPending()  : bool
jsonSerialize()  : array<string|int, mixed>
setJobId()  : self
setOperationStatus()  : self

Constants

ALL_OPERATION_STATUSES

public mixed ALL_OPERATION_STATUSES = [self::OPERATION_STATUS_CONFLICT, self::OPERATION_STATUS_APPLIED, self::OPERATION_STATUS_REJECTED]

MAX_RETRY_COUNT

public mixed MAX_RETRY_COUNT = 1

OPERATION_STATUS_APPLIED

public mixed OPERATION_STATUS_APPLIED = 'APPLIED'

OPERATION_STATUS_CONFLICT

public mixed OPERATION_STATUS_CONFLICT = 'CONFLICT'

OPERATION_STATUS_REJECTED

public mixed OPERATION_STATUS_REJECTED = 'REJECTED'

Methods

__clone()

public __clone() : mixed

__construct()

public __construct(int $typeId[, ItemIdentifier|null $target = null ][, int|null $userId = null ][, int|null $jobId = null ][, bool $isPending = true ][, T|null $payload = null ][, string|null $operationStatus = null ][, int|null $parentJobId = null ][, int|null $retryCount = null ][, bool $isManualLaunch = true ][, string|null $languageId = null ][, int|null $nextTypeId = null ]) : mixed
Parameters
$typeId : int
$target : ItemIdentifier|null = null
$userId : int|null = null
$jobId : int|null = null
$isPending : bool = true
$payload : T|null = null
$operationStatus : string|null = null
$parentJobId : int|null = null
$retryCount : int|null = null
$isManualLaunch : bool = true
$languageId : string|null = null
$nextTypeId : int|null = null

getJobId()

public getJobId() : int|null
Return values
int|null

getLanguageId()

public getLanguageId() : string|null
Return values
string|null

getNextTypeId()

public getNextTypeId() : int|null
Return values
int|null

getOperationStatus()

public getOperationStatus() : string|null
Return values
string|null

getParentJobId()

public getParentJobId() : int|null
Return values
int|null

getPayload()

public getPayload() : T|null
Return values
T|null

getRetryCount()

public getRetryCount() : int|null
Return values
int|null

getTarget()

public getTarget() : ItemIdentifier|null
Return values
ItemIdentifier|null

getTypeId()

public getTypeId() : int
Return values
int

getUserId()

public getUserId() : int|null
Return values
int|null

isErrorsLimitExceeded()

public isErrorsLimitExceeded() : bool
Return values
bool

isFinalOperationStatus()

public static isFinalOperationStatus(string|null $operationStatus) : bool
Parameters
$operationStatus : string|null
Return values
bool

isInFinalOperationStatus()

public isInFinalOperationStatus() : bool
Return values
bool

isManualLaunch()

public isManualLaunch() : bool
Return values
bool

isPending()

public isPending() : bool
Return values
bool

jsonSerialize()

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

setJobId()

public setJobId(int $jobId) : self
Parameters
$jobId : int
Return values
self

setOperationStatus()

public setOperationStatus(string $operationStatus) : self
Parameters
$operationStatus : string
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results