Bitrix API

State

Class State

Table of Contents

Constants

HALTED  = 'H'
INIT  = 'I'
NEWISH  = 'N'
PAUSED  = 'P'
PLANNED  = 'T'
READY  = 'R'
SENDING  = 'S'
SENT  = 'Y'
STOPPED  = 'X'
WAITING  = 'W'

Methods

__construct()  : mixed
Constructor.
canHalt()  : bool
Check halt possibility.
canInit()  : bool
Check init possibility.
canPause()  : bool
Check pause possibility.
canPlan()  : bool
Check plan possibility.
canReady()  : bool
Check ready possibility.
canReset()  : bool
Check reset possibility.
canResume()  : bool
Check resume possibility.
canSend()  : bool
Check send possibility.
canSendErrors()  : bool
Check send errors possibility.
canStop()  : bool
Check stop possibility.
canWait()  : bool
Check wait possibility.
getCode()  : string
Get current state code.
getDateCreate()  : string|DateTime|null
Get create date.
getDatePause()  : string|DateTime|null
Get send date.
getDateSend()  : string|DateTime|null
Get sent date.
getDateSent()  : string|DateTime|null
Get send date.
getLastExecutedDate()  : string|DateTime|null
Get last exec date.
getList()  : array<string|int, mixed>
Get states.
getName()  : string
Get current state name.
getPlannedDateSend()  : string|DateTime|null
Get planned date send.
halt()  : bool
Halt.
init()  : bool
Init.
isFinished()  : bool
Is finished.
isHalted()  : bool
Is halted.
isPaused()  : bool
Is sending paused.
isPlanned()  : bool
Is sending planned.
isReady()  : bool
Is ready to send.
isSending()  : bool
Is sending started.
isSendingLimitExceeded()  : bool
Is sending limit exceeded.
isSendingLimitTemporary()  : bool
Is sending limit exceeded.
isSendingLimitWaiting()  : bool
Is sending limit waiting.
isSendingPlanned()  : bool
Is sending limit exceeded.
isSent()  : bool
Is sent.
isStopped()  : bool
Is stopped.
isWaiting()  : bool
Is sending started.
pause()  : bool
Pause.
plan()  : bool
Plan sending.
ready()  : bool
Change state to ready.
reset()  : bool
Reset.
resume()  : bool
Resume.
send()  : bool
Send.
sendErrors()  : bool
Send errors.
stop()  : bool
Stop.
updatePlannedDateSend()  : bool
Update planed date send.
wait()  : bool
Wait.
wasPostingBuilt()  : bool
Is posting was built.
wasStartedSending()  : bool
Is sending was started.

Constants

HALTED

public mixed HALTED = 'H'

INIT

public mixed INIT = 'I'

NEWISH

public mixed NEWISH = 'N'

PAUSED

public mixed PAUSED = 'P'

PLANNED

public mixed PLANNED = 'T'

READY

public mixed READY = 'R'

SENDING

public mixed SENDING = 'S'

SENT

public mixed SENT = 'Y'

STOPPED

public mixed STOPPED = 'X'

WAITING

public mixed WAITING = 'W'

Methods

__construct()

Constructor.

public __construct(Letter $letter) : mixed
Parameters
$letter : Letter

Letter.

canHalt()

Check halt possibility.

public canHalt() : bool
Return values
bool

canInit()

Check init possibility.

public canInit() : bool
Return values
bool

canPause()

Check pause possibility.

public canPause() : bool
Return values
bool

canPlan()

Check plan possibility.

public canPlan() : bool
Return values
bool

canReady()

Check ready possibility.

public canReady() : bool
Return values
bool

canReset()

Check reset possibility.

public canReset() : bool
Return values
bool

canResume()

Check resume possibility.

public canResume() : bool
Return values
bool

canSend()

Check send possibility.

public canSend() : bool
Return values
bool

canSendErrors()

Check send errors possibility.

public canSendErrors() : bool
Return values
bool

canStop()

Check stop possibility.

public canStop() : bool
Return values
bool

canWait()

Check wait possibility.

public canWait() : bool
Return values
bool

getCode()

Get current state code.

public getCode() : string
Return values
string

getDateCreate()

Get create date.

public getDateCreate() : string|DateTime|null
Return values
string|DateTime|null

getDatePause()

Get send date.

public getDatePause() : string|DateTime|null
Return values
string|DateTime|null

getDateSend()

Get sent date.

public getDateSend() : string|DateTime|null
Return values
string|DateTime|null

getDateSent()

Get send date.

public getDateSent() : string|DateTime|null
Return values
string|DateTime|null

getLastExecutedDate()

Get last exec date.

public getLastExecutedDate() : string|DateTime|null
Return values
string|DateTime|null

getList()

Get states.

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

getName()

Get current state name.

public getName() : string
Return values
string

getPlannedDateSend()

Get planned date send.

public getPlannedDateSend() : string|DateTime|null
Return values
string|DateTime|null

halt()

Halt.

public halt() : bool
Tags
throws
InvalidOperationException
Return values
bool

init()

Init.

public init() : bool
Tags
throws
InvalidOperationException
Return values
bool

isFinished()

Is finished.

public isFinished() : bool
Return values
bool

isHalted()

Is halted.

public isHalted() : bool
Return values
bool

isPaused()

Is sending paused.

public isPaused() : bool
Return values
bool

isPlanned()

Is sending planned.

public isPlanned() : bool
Return values
bool

isReady()

Is ready to send.

public isReady() : bool
Return values
bool

isSending()

Is sending started.

public isSending() : bool
Return values
bool

isSendingLimitExceeded()

Is sending limit exceeded.

public isSendingLimitExceeded() : bool
Return values
bool

isSendingLimitTemporary()

Is sending limit exceeded.

public isSendingLimitTemporary() : bool
Return values
bool

isSendingLimitWaiting()

Is sending limit waiting.

public isSendingLimitWaiting() : bool
Return values
bool

isSendingPlanned()

Is sending limit exceeded.

public isSendingPlanned() : bool
Return values
bool

isSent()

Is sent.

public isSent() : bool
Return values
bool

isStopped()

Is stopped.

public isStopped() : bool
Return values
bool

isWaiting()

Is sending started.

public isWaiting() : bool
Return values
bool

pause()

Pause.

public pause() : bool
Tags
throws
InvalidOperationException
Return values
bool

plan()

Plan sending.

public plan(Date $sendDate) : bool
Parameters
$sendDate : Date

Send date.

Tags
throws
InvalidOperationException
Return values
bool

ready()

Change state to ready.

public ready() : bool
Tags
throws
InvalidOperationException
Return values
bool

reset()

Reset.

public reset() : bool
Tags
throws
InvalidOperationException
throws
NotImplementedException
Return values
bool

resume()

Resume.

public resume() : bool
Tags
throws
InvalidOperationException
Return values
bool

send()

Send.

public send() : bool
Tags
throws
InvalidOperationException
Return values
bool

sendErrors()

Send errors.

public sendErrors() : bool
Tags
throws
InvalidOperationException
Return values
bool

stop()

Stop.

public stop() : bool
Tags
throws
InvalidOperationException
Return values
bool

updatePlannedDateSend()

Update planed date send.

public updatePlannedDateSend(Date $date) : bool
Parameters
$date : Date

Date.

Return values
bool

wait()

Wait.

public wait([MethodSchedule|null $method = null ]) : bool
Parameters
$method : MethodSchedule|null = null

Method.

Tags
throws
InvalidOperationException
Return values
bool

wasPostingBuilt()

Is posting was built.

public wasPostingBuilt() : bool
Return values
bool

wasStartedSending()

Is sending was started.

public wasStartedSending() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results