Bitrix API

Toloka extends Letter

Class Base

Table of Contents

Constants

SEARCH_FIELD_NAME  = 'SEARCH_CONTENT'

Methods

__construct()  : mixed
Base constructor.
addError()  : mixed
Add error.
canChangeSegments()  : bool
Return true if can change segments.
canChangeTemplate()  : bool
Return true if can change template.
clearErrors()  : mixed
Clear errors.
copy()  : int|null
Copy.
create()  : static
Create instance.
createInstanceByArray()  : static|Letter|Ad|Rc|null
Create instance by array data.
createInstanceByContactId()  : static|Ad|null
Create instance by contact ID.
createInstanceById()  : static|Letter|Ad|Rc|null
Create instance by ID.
createInstanceByPostingId()  : static|Ad|null
Create instance by posting ID.
get()  : mixed
Get data value by key.
getCampaignId()  : mixed
Get campaign ID.
getCounter()  : Counter
Get counter instance.
getData()  : mixed
Get data.
getDataClass()  : DataManager
Get data manager.
getDefaultSelectFields()  : mixed
getDuration()  : Duration
Get duration instance.
getErrorCollection()  : ErrorCollection
Get error collection.
getErrorMessages()  : array<string|int, mixed>
Get error messages.
getErrors()  : array<string|int, mixed>
Get errors.
getId()  : int
Get ID.
getLastPostingData()  : array<string|int, mixed>
Get last posting data.
getList()  : Result
Get list.
getListWithMessageFields()  : ArrayResult
Get list with message fields
getMessage()  : Adapter
Get Message instance.
getMethod()  : Method
Get method instance.
getSearchBuilder()  : null|Builder
Get data class.
getState()  : State
Get state instance.
getUser()  : mixed
Get user.
halt()  : bool
Halt.
hasErrors()  : bool
Return true if it have errors.
hasStatistics()  : bool
Return true if it have statistics.
isReiterate()  : bool
Is reiterate letter.
isSupportHeatMap()  : bool
Is support heat map.
isSupportReiterate()  : bool
Is support reiterate run.
isSupportTesting()  : bool
Is support testing.
isTrigger()  : bool
Is trigger letter.
load()  : bool
Load.
loadByArray()  : bool
Load by array.
loadData()  : array<string|int, mixed>|null
Load data.
loadDataSegments()  : array<string|int, mixed>
Load segments data.
mergeData()  : $this
Merge data.
pause()  : bool
Pause.
plan()  : bool
Plan sending.
remove()  : bool
Remove.
removeById()  : bool
Remove by letter ID.
resume()  : bool
Resume.
save()  : mixed
Save.
saveSearchIndex()  : bool
Save search index.
send()  : bool
Send.
sendErrors()  : bool
Send errors.
set()  : $this
Set data value by key.
setData()  : $this
Set data.
setId()  : $this
Set ID.
setUser()  : mixed
Set user.
stop()  : bool
Stop.
test()  : Result
Send test message to recipient.
unsetByKey()  : $this
Unset data value by key.
wait()  : bool
Wait sending.

Constants

SEARCH_FIELD_NAME

public mixed SEARCH_FIELD_NAME = 'SEARCH_CONTENT'

Methods

__construct()

Base constructor.

public __construct([int|null $id = null ]) : mixed
Parameters
$id : int|null = null

ID.

addError()

Add error.

public addError(string $message[, string|null $code = null ]) : mixed
Parameters
$message : string

Message text.

$code : string|null = null

Code.

canChangeSegments()

Return true if can change segments.

public canChangeSegments() : bool
Return values
bool

canChangeTemplate()

Return true if can change template.

public canChangeTemplate() : bool
Return values
bool

clearErrors()

Clear errors.

public clearErrors() : mixed

copy()

Copy.

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

create()

Create instance.

public static create([int|null $id = null ]) : static
Parameters
$id : int|null = null

ID.

Return values
static

createInstanceByArray()

Create instance by array data.

public static createInstanceByArray(array<string|int, mixed> $data[, array<string|int, mixed> $messageCodes = [] ]) : static|Letter|Ad|Rc|null
Parameters
$data : array<string|int, mixed>

Data.

$messageCodes : array<string|int, mixed> = []

Message codes.

Return values
static|Letter|Ad|Rc|null

createInstanceByContactId()

Create instance by contact ID.

public static createInstanceByContactId(int $contactId[, array<string|int, mixed> $messageCodes = [] ]) : static|Ad|null
Parameters
$contactId : int

Contact ID.

$messageCodes : array<string|int, mixed> = []

Message codes.

Return values
static|Ad|null

createInstanceById()

Create instance by ID.

public static createInstanceById([int|null $id = null ][, array<string|int, mixed> $messageCodes = [] ]) : static|Letter|Ad|Rc|null
Parameters
$id : int|null = null

ID.

$messageCodes : array<string|int, mixed> = []

Message codes.

Return values
static|Letter|Ad|Rc|null

createInstanceByPostingId()

Create instance by posting ID.

public static createInstanceByPostingId(int $postingId) : static|Ad|null
Parameters
$postingId : int

Posting ID.

Return values
static|Ad|null

get()

Get data value by key.

public get(string $key[, mixed|null $defaultValue = null ]) : mixed
Parameters
$key : string

Key.

$defaultValue : mixed|null = null

Default value.

getCampaignId()

Get campaign ID.

public getCampaignId() : mixed

getData()

Get data.

public getData() : mixed

getDataClass()

Get data manager.

public static getDataClass() : DataManager
Return values
DataManager

getDefaultSelectFields()

public static getDefaultSelectFields() : mixed

getErrorCollection()

Get error collection.

public getErrorCollection() : ErrorCollection
Return values
ErrorCollection

getErrorMessages()

Get error messages.

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

getErrors()

Get errors.

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

getId()

Get ID.

public getId() : int
Return values
int

getLastPostingData()

Get last posting data.

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

getList()

Get list.

public static getList([array<string|int, mixed> $parameters = array() ]) : Result
Parameters
$parameters : array<string|int, mixed> = array()

Parameters.

Return values
Result

getListWithMessageFields()

Get list with message fields

public static getListWithMessageFields([array<string|int, mixed> $parameters = array() ]) : ArrayResult
Parameters
$parameters : array<string|int, mixed> = array()

Getlist params.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
ArrayResult

getMessage()

Get Message instance.

public getMessage() : Adapter
Tags
throws
ArgumentException
Return values
Adapter

getSearchBuilder()

Get data class.

public static getSearchBuilder() : null|Builder
Return values
null|Builder

getUser()

Get user.

public getUser() : mixed
Tags
@return

Security\User;

halt()

Halt.

public halt() : bool
Return values
bool

hasErrors()

Return true if it have errors.

public hasErrors() : bool
Return values
bool

hasStatistics()

Return true if it have statistics.

public hasStatistics() : bool
Return values
bool

isReiterate()

Is reiterate letter.

public isReiterate() : bool
Return values
bool

isSupportHeatMap()

Is support heat map.

public isSupportHeatMap() : bool
Return values
bool

isSupportReiterate()

Is support reiterate run.

public isSupportReiterate() : bool
Return values
bool

isSupportTesting()

Is support testing.

public isSupportTesting() : bool
Return values
bool

isTrigger()

Is trigger letter.

public isTrigger() : bool
Return values
bool

load()

Load.

public load(int $id) : bool
Parameters
$id : int

ID.

Return values
bool

loadByArray()

Load by array.

public loadByArray(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

Data.

Return values
bool

loadData()

Load data.

public loadData(int $id) : array<string|int, mixed>|null
Parameters
$id : int

ID.

Return values
array<string|int, mixed>|null

loadDataSegments()

Load segments data.

public loadDataSegments(int $id) : array<string|int, mixed>
Parameters
$id : int

ID.

Return values
array<string|int, mixed>

mergeData()

Merge data.

public mergeData(array<string|int, mixed> $data) : $this
Parameters
$data : array<string|int, mixed>

Data.

Return values
$this

pause()

Pause.

public pause() : bool
Return values
bool

plan()

Plan sending.

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

Date.

Return values
bool

remove()

Remove.

public remove() : bool
Return values
bool

removeById()

Remove by letter ID.

public static removeById(int $id) : bool
Parameters
$id : int

Letter ID.

Return values
bool

resume()

Resume.

public resume() : bool
Return values
bool

save()

Save.

public save() : mixed

saveSearchIndex()

Save search index.

public saveSearchIndex() : bool
Return values
bool

send()

Send.

public send() : bool
Return values
bool

sendErrors()

Send errors.

public sendErrors() : bool
Return values
bool

set()

Set data value by key.

public set(string $key, mixed $value) : $this
Parameters
$key : string

Key.

$value : mixed

Value.

Return values
$this

setData()

Set data.

public setData(array<string|int, mixed> $data) : $this
Parameters
$data : array<string|int, mixed>

Data.

Return values
$this

setId()

Set ID.

public setId(int $id) : $this
Parameters
$id : int

ID.

Return values
$this

setUser()

Set user.

public setUser([User|null $user = null ]) : mixed
Parameters
$user : User|null = null

User.

Tags
@return

$this;

stop()

Stop.

public stop() : bool
Return values
bool

test()

Send test message to recipient.

public test(array<string|int, mixed> $codes[, array<string|int, mixed> $parameters = array() ]) : Result
Parameters
$codes : array<string|int, mixed>

Recipient codes.

$parameters : array<string|int, mixed> = array()

Parameters.

Return values
Result

unsetByKey()

Unset data value by key.

public unsetByKey(string $key) : $this
Parameters
$key : string

Key.

Return values
$this

wait()

Wait sending.

public wait() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results