Bitrix API

CallList

FinalYes

Table of Contents

Constants

ITEMS_LIMIT  = 500
STATUS_IN_WORK  = 'IN_WORK'

Methods

addCreatedEntity()  : mixed
addEntities()  : mixed
addEntitiesFromGrid()  : mixed
addItem()  : mixed
applyOriginalFilter()  : mixed
Kinda workaround functions that applies original filter settings, which were used to build this call list.
completeAssociatedActivity()  : mixed
Finishes activity, associated with the call list.
convertItemsToBindings()  : array<string|int, mixed>
Returns items, converted to the array of activity bindings.
createActivity()  : Result
Creates new Activity, associatied with the current call list.
createEmpty()  : mixed
createWithEntities()  : CallList
createWithGridId()  : CallList
createWithId()  : static
deleteByOwner()  : mixed
deleteItems()  : mixed
Delete elements from call list.
getCreatedBy()  : mixed
getDateCreate()  : mixed
getDefaultSubject()  : string
Returns default call list activity subject.
getEntityTypeId()  : mixed
getFilterParameters()  : mixed
getGridId()  : mixed
getId()  : int
getItems()  : array<string|int, Item>
getItemsCount()  : int
Returns count of the list items.
getLicensePopupContent()  : mixed
getLicensePopupHeader()  : mixed
getProLink()  : mixed
getStatusList()  : array<string|int, mixed>
getWebformId()  : mixed
handleOnCrmCompanyListItemBuildMenu()  : mixed
Handler for the event onCrmCompanyListItemBuildMenu.
handleOnCrmContactListItemBuildMenu()  : mixed
Handler for the event onCrmContactListItemBuildMenu.
handleOnCrmDealListItemBuildMenu()  : mixed
Handler for the event onCrmDealListItemBuildMenu.
handleOnCrmInvoiceListItemBuildMenu()  : mixed
Handler for the event onCrmInvoiceListItemBuildMenu.
handleOnCrmLeadListItemBuildMenu()  : mixed
Handler for the event onCrmLeadListItemBuildMenu.
handleOnCrmOrderListItemBuildMenu()  : mixed
Handler for the event onCrmQuoteListItemBuildMenu.
handleOnCrmQuoteListItemBuildMenu()  : mixed
Handler for the event onCrmQuoteListItemBuildMenu.
isAvailable()  : mixed
isEntityTypeSupported()  : bool
isFiltered()  : mixed
persist()  : mixed
setElementCall()  : bool
Sets call reference for the element of the list.
setElementRank()  : mixed
setElementStatus()  : mixed
setEntityTypeId()  : mixed
setFiltered()  : mixed
setFilterParameters()  : mixed
setGridId()  : mixed
setWebformId()  : mixed
toArray()  : array<string|int, mixed>
Returns call list converted to an array.
transferOwnership()  : mixed

Constants

ITEMS_LIMIT

public mixed ITEMS_LIMIT = 500

STATUS_IN_WORK

public mixed STATUS_IN_WORK = 'IN_WORK'

Methods

addCreatedEntity()

public addCreatedEntity(mixed $elementId, mixed $createdEntityType, mixed $createdEntityId) : mixed
Parameters
$elementId : mixed
$createdEntityType : mixed
$createdEntityId : mixed

addEntities()

public addEntities(array<string|int, int> $entityIds) : mixed
Parameters
$entityIds : array<string|int, int>

Array of entity ids to be added to the call list

addEntitiesFromGrid()

public addEntitiesFromGrid(mixed $gridId) : mixed
Parameters
$gridId : mixed

applyOriginalFilter()

Kinda workaround functions that applies original filter settings, which were used to build this call list.

public applyOriginalFilter() : mixed

completeAssociatedActivity()

Finishes activity, associated with the call list.

public completeAssociatedActivity() : mixed

convertItemsToBindings()

Returns items, converted to the array of activity bindings.

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

createActivity()

Creates new Activity, associatied with the current call list.

public createActivity([string $subject = '' ][, string $description = '' ]) : Result
Parameters
$subject : string = ''

Subject of the activity.

$description : string = ''

Description of the activity.

Return values
Result

createEmpty()

public static createEmpty() : mixed

createWithEntities()

public static createWithEntities(string $entityType, array<string|int, int> $entityIds) : CallList
Parameters
$entityType : string

Type of the entities used to build the call list (LEAD|CONTACT|COMPANY).

$entityIds : array<string|int, int>

Array of the entity's ids.

Return values
CallList

createWithGridId()

public static createWithGridId(string $entityType, string $gridId) : CallList
Parameters
$entityType : string
$gridId : string
Return values
CallList

createWithId()

public static createWithId(int $id[, bool $loadItems = false ][, array<string|int, mixed> $options = [] ]) : static
Parameters
$id : int
$loadItems : bool = false
$options : array<string|int, mixed> = []
Tags
throws
ArgumentException
throws
SystemException
Return values
static

deleteByOwner()

public static deleteByOwner(mixed $entityTypeId, mixed $entityId) : mixed
Parameters
$entityTypeId : mixed
$entityId : mixed

deleteItems()

Delete elements from call list.

public deleteItems(array<string|int, mixed> $elements) : mixed
Parameters
$elements : array<string|int, mixed>

Array of element ids to be deleted.

getCreatedBy()

public getCreatedBy() : mixed

getDateCreate()

public getDateCreate() : mixed

getDefaultSubject()

Returns default call list activity subject.

public getDefaultSubject() : string
Return values
string

getEntityTypeId()

public getEntityTypeId() : mixed

getFilterParameters()

public getFilterParameters() : mixed

getId()

public getId() : int
Return values
int

getItems()

public getItems() : array<string|int, Item>
Return values
array<string|int, Item>

getItemsCount()

Returns count of the list items.

public getItemsCount([mixed $statusId = null ]) : int
Parameters
$statusId : mixed = null
Return values
int

getLicensePopupContent()

public static getLicensePopupContent() : mixed

getLicensePopupHeader()

public static getLicensePopupHeader() : mixed

getProLink()

public static getProLink() : mixed

getStatusList()

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

getWebformId()

public getWebformId() : mixed

handleOnCrmCompanyListItemBuildMenu()

Handler for the event onCrmCompanyListItemBuildMenu.

public static handleOnCrmCompanyListItemBuildMenu(mixed $restPlacement, mixed $params, array<string|int, mixed> &$menu) : mixed

Rewrites contact's actions menu.

Parameters
$restPlacement : mixed
$params : mixed
$menu : array<string|int, mixed>

handleOnCrmContactListItemBuildMenu()

Handler for the event onCrmContactListItemBuildMenu.

public static handleOnCrmContactListItemBuildMenu(mixed $restPlacement, mixed $params, array<string|int, mixed> &$menu) : mixed

Rewrites contact's actions menu.

Parameters
$restPlacement : mixed
$params : mixed
$menu : array<string|int, mixed>

handleOnCrmDealListItemBuildMenu()

Handler for the event onCrmDealListItemBuildMenu.

public static handleOnCrmDealListItemBuildMenu(mixed $restPlacement, mixed $params, array<string|int, mixed> &$menu) : mixed

Rewrites deal's actions menu.

Parameters
$restPlacement : mixed
$params : mixed
$menu : array<string|int, mixed>

handleOnCrmInvoiceListItemBuildMenu()

Handler for the event onCrmInvoiceListItemBuildMenu.

public static handleOnCrmInvoiceListItemBuildMenu(mixed $restPlacement, mixed $params, array<string|int, mixed> &$menu) : mixed

Rewrites invoice's actions menu.

Parameters
$restPlacement : mixed
$params : mixed
$menu : array<string|int, mixed>

handleOnCrmLeadListItemBuildMenu()

Handler for the event onCrmLeadListItemBuildMenu.

public static handleOnCrmLeadListItemBuildMenu(mixed $restPlacement, mixed $params, array<string|int, mixed> &$menu) : mixed

Rewrites contact's actions menu.

Parameters
$restPlacement : mixed
$params : mixed
$menu : array<string|int, mixed>

handleOnCrmOrderListItemBuildMenu()

Handler for the event onCrmQuoteListItemBuildMenu.

public static handleOnCrmOrderListItemBuildMenu(mixed $restPlacement, mixed $params, array<string|int, mixed> &$menu) : mixed

Rewrites quote's actions menu.

Parameters
$restPlacement : mixed
$params : mixed
$menu : array<string|int, mixed>

handleOnCrmQuoteListItemBuildMenu()

Handler for the event onCrmQuoteListItemBuildMenu.

public static handleOnCrmQuoteListItemBuildMenu(mixed $restPlacement, mixed $params, array<string|int, mixed> &$menu) : mixed

Rewrites quote's actions menu.

Parameters
$restPlacement : mixed
$params : mixed
$menu : array<string|int, mixed>

isAvailable()

public static isAvailable() : mixed

isEntityTypeSupported()

public final static isEntityTypeSupported(int $entityTypeId) : bool
Parameters
$entityTypeId : int
Return values
bool

isFiltered()

public isFiltered() : mixed

setElementCall()

Sets call reference for the element of the list.

public setElementCall(int $elementId, string $callId) : bool
Parameters
$elementId : int

Id of the crm entity.

$callId : string

Id of th call.

Return values
bool —

Returns true if call list has element with the specified id and false otherwise.

setElementRank()

public setElementRank(mixed $elementId, mixed $rank) : mixed
Parameters
$elementId : mixed
$rank : mixed

setElementStatus()

public setElementStatus(mixed $elementId, mixed $statusId) : mixed
Parameters
$elementId : mixed
$statusId : mixed

setEntityTypeId()

public setEntityTypeId(mixed $entityTypeId) : mixed
Parameters
$entityTypeId : mixed

setFiltered()

public setFiltered(mixed $filtered) : mixed
Parameters
$filtered : mixed

setFilterParameters()

public setFilterParameters(mixed $filterParameters) : mixed
Parameters
$filterParameters : mixed

setGridId()

public setGridId(mixed $gridId) : mixed
Parameters
$gridId : mixed

setWebformId()

public setWebformId(mixed $webformId) : mixed
Parameters
$webformId : mixed

toArray()

Returns call list converted to an array.

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

transferOwnership()

public static transferOwnership(mixed $oldEntityTypeId, mixed $oldEntityId, mixed $newEntityTypeId, mixed $newEntityId) : mixed
Parameters
$oldEntityTypeId : mixed
$oldEntityId : mixed
$newEntityTypeId : mixed
$newEntityId : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results