Bitrix API

Result

Class Result

Table of Contents

Methods

getDateSent()  : string
Get date sent.
getDescription()  : string
Get description text.
getEmail()  : string
Get email.
getEntityId()  : string
Get entity ID.
getEntityType()  : string
Get entity type.
getMessage()  : string
Get message text.
getModuleId()  : string
Get module ID.
isBelongTo()  : bool
Return true if result is belong to module ID and entity type.
isBlacklistable()  : bool
Return true if email is blacklistable.
isError()  : bool
Return true if error.
isNewest()  : bool
Return true if result is newest than custom date.
isPermanentError()  : bool
Return true if permanent error.
sendEvent()  : bool
Send event of receiving result.
setBlacklistable()  : $this
Set as blacklistable.
setDateSent()  : $this
Set date sent.
setDescription()  : $this
Set description text.
setEmail()  : $this
Set email.
setEntityId()  : $this
Set entity ID.
setEntityType()  : $this
Set entity type.
setError()  : $this
Set as error.
setMessage()  : $this
Set message text.
setModuleId()  : $this
Set module ID.
setPermanentError()  : $this
Set as permanent error.

Methods

getDateSent()

Get date sent.

public getDateSent() : string
Return values
string

getDescription()

Get description text.

public getDescription() : string
Return values
string

getEmail()

Get email.

public getEmail() : string
Return values
string

getEntityId()

Get entity ID.

public getEntityId() : string
Return values
string

getEntityType()

Get entity type.

public getEntityType() : string
Return values
string

getMessage()

Get message text.

public getMessage() : string
Return values
string

getModuleId()

Get module ID.

public getModuleId() : string
Return values
string

isBelongTo()

Return true if result is belong to module ID and entity type.

public isBelongTo(string $moduleId[, string $entityType = null ]) : bool
Parameters
$moduleId : string

Module ID.

$entityType : string = null

|null Entity type.

Return values
bool

isBlacklistable()

Return true if email is blacklistable.

public isBlacklistable() : bool
Return values
bool

isError()

Return true if error.

public isError() : bool
Return values
bool

isNewest()

Return true if result is newest than custom date.

public isNewest(DateTime|int $dateSent) : bool
Parameters
$dateSent : DateTime|int

Date sent.

Return values
bool

isPermanentError()

Return true if permanent error.

public isPermanentError() : bool
Return values
bool

sendEvent()

Send event of receiving result.

public sendEvent() : bool
Return values
bool

setBlacklistable()

Set as blacklistable.

public setBlacklistable(bool $isBlacklistable) : $this
Parameters
$isBlacklistable : bool

Is blacklistable.

Return values
$this

setDateSent()

Set date sent.

public setDateSent(string $dateSent) : $this
Parameters
$dateSent : string

Date sent.

Return values
$this

setDescription()

Set description text.

public setDescription(string $description) : $this
Parameters
$description : string

Description.

Return values
$this

setEmail()

Set email.

public setEmail(string $email) : $this
Parameters
$email : string

Email.

Return values
$this

setEntityId()

Set entity ID.

public setEntityId(string $entityId) : $this
Parameters
$entityId : string

Entity ID.

Return values
$this

setEntityType()

Set entity type.

public setEntityType(string $entityType) : $this
Parameters
$entityType : string

Entity type.

Return values
$this

setError()

Set as error.

public setError(bool $isError) : $this
Parameters
$isError : bool

Is error.

Return values
$this

setMessage()

Set message text.

public setMessage(string $message) : $this
Parameters
$message : string

Message.

Return values
$this

setModuleId()

Set module ID.

public setModuleId(string $moduleId) : $this
Parameters
$moduleId : string

Module ID.

Return values
$this

setPermanentError()

Set as permanent error.

public setPermanentError(bool $isPermanentError) : $this
Parameters
$isPermanentError : bool

Is permanent error.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results