Bitrix API

LeadSettings uses EnableFactory

Table of Contents

Constants

CRM_TYPE_MENU_ITEM_ID  = 'crm-type-button'
VIEW_CALENDAR  = \Bitrix\Crm\Settings\EntityViewSettings::CALENDAR_VIEW
VIEW_KANBAN  = \Bitrix\Crm\Settings\EntityViewSettings::KANBAN_VIEW
VIEW_LIST  = \Bitrix\Crm\Settings\EntityViewSettings::LIST_VIEW

Methods

__construct()  : mixed
enableAutoGenRc()  : void
Enable auto generate of RC(return customer).
enableAutoUsingFinishedLead()  : void
Enable using finished lead for auto generating.
enableDeferredCleaning()  : void
Enable enable deferred cleaning of related entities during deletion operation.
enableLead()  : bool
Enable leads
enableProductRowExport()  : void
Enable export of the product rows
enableRecycleBin()  : void
Enable deletion to recycle bin.
getActivityCompletionConfig()  : mixed
getCrmTypeMenuItem()  : array<string|int, mixed>
getCurrent()  : LeadSettings
Get current instance
getCurrentListViewID()  : int
Get current list view ID
getDefaultListViewID()  : int
Get default list view ID
getFreeModeConverterConfig()  : mixed
getOpenedFlag()  : bool
Get value of flag 'OPENED'
getViewDescriptions()  : array<string|int, mixed>
Get descriptions of views supported in current context
isAutoGenRcEnabled()  : bool
Return true if auto generate of RC(return customer) is enabled.
isAutoUsingFinishedLeadEnabled()  : bool
Return true if using finished lead for auto generating is enabled.
isDeferredCleaningEnabled()  : bool
Return true if deferred cleaning of related entities during deletion operation is enabled.
isEnabled()  : bool
Check if leads are enabled
isFactoryEnabled()  : bool
Return true if new interface and api through Service\Factory is used to process this entity type.
isProductRowExportEnabled()  : bool
Check if export of the product rows is enabled
isRecycleBinEnabled()  : bool
Return true if deletion to recycle bin is enabled.
prepareViewListItems()  : array<string|int, mixed>
Prepare list items for view selector
resetActivityCompletionConfig()  : mixed
setActivityCompletionConfig()  : mixed
setDefaultListViewID()  : void
Set default list view ID
setFactoryEnabled()  : void
Set state of isFactoryEnabled setting.
setFreeModeConverterConfig()  : mixed
setOpenedFlag()  : void
Set value of flag 'OPENED'
showCrmTypePopup()  : mixed

Constants

CRM_TYPE_MENU_ITEM_ID

public mixed CRM_TYPE_MENU_ITEM_ID = 'crm-type-button'

VIEW_CALENDAR

public mixed VIEW_CALENDAR = \Bitrix\Crm\Settings\EntityViewSettings::CALENDAR_VIEW

VIEW_KANBAN

public mixed VIEW_KANBAN = \Bitrix\Crm\Settings\EntityViewSettings::KANBAN_VIEW

VIEW_LIST

public mixed VIEW_LIST = \Bitrix\Crm\Settings\EntityViewSettings::LIST_VIEW

Methods

enableAutoGenRc()

Enable auto generate of RC(return customer).

public enableAutoGenRc(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

enableAutoUsingFinishedLead()

Enable using finished lead for auto generating.

public enableAutoUsingFinishedLead(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

enableDeferredCleaning()

Enable enable deferred cleaning of related entities during deletion operation.

public enableDeferredCleaning(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

enableLead()

Enable leads

public static enableLead(bool $enabled) : bool
Parameters
$enabled : bool

Enabled Flag.

Return values
bool

enableProductRowExport()

Enable export of the product rows

public enableProductRowExport(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

enableRecycleBin()

Enable deletion to recycle bin.

public enableRecycleBin(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

getActivityCompletionConfig()

public getActivityCompletionConfig() : mixed

getCrmTypeMenuItem()

public static getCrmTypeMenuItem([bool $compatibleKeys = false ]) : array<string|int, mixed>
Parameters
$compatibleKeys : bool = false
Return values
array<string|int, mixed>

getCurrentListViewID()

Get current list view ID

public getCurrentListViewID() : int
Return values
int

getDefaultListViewID()

Get default list view ID

public getDefaultListViewID() : int
Return values
int

getFreeModeConverterConfig()

public getFreeModeConverterConfig() : mixed

getOpenedFlag()

Get value of flag 'OPENED'

public getOpenedFlag() : bool
Return values
bool

getViewDescriptions()

Get descriptions of views supported in current context

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

isAutoGenRcEnabled()

Return true if auto generate of RC(return customer) is enabled.

public isAutoGenRcEnabled() : bool
Return values
bool

isAutoUsingFinishedLeadEnabled()

Return true if using finished lead for auto generating is enabled.

public isAutoUsingFinishedLeadEnabled() : bool
Return values
bool

isDeferredCleaningEnabled()

Return true if deferred cleaning of related entities during deletion operation is enabled.

public isDeferredCleaningEnabled() : bool
Return values
bool

isEnabled()

Check if leads are enabled

public static isEnabled() : bool
Return values
bool

isFactoryEnabled()

Return true if new interface and api through Service\Factory is used to process this entity type.

public isFactoryEnabled() : bool
Return values
bool

isProductRowExportEnabled()

Check if export of the product rows is enabled

public isProductRowExportEnabled() : bool
Return values
bool

isRecycleBinEnabled()

Return true if deletion to recycle bin is enabled.

public isRecycleBinEnabled() : bool
Return values
bool

prepareViewListItems()

Prepare list items for view selector

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

resetActivityCompletionConfig()

public resetActivityCompletionConfig() : mixed

setActivityCompletionConfig()

public setActivityCompletionConfig(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>

setDefaultListViewID()

Set default list view ID

public setDefaultListViewID(int $viewID) : void
Parameters
$viewID : int

View ID.

setFactoryEnabled()

Set state of isFactoryEnabled setting.

public setFactoryEnabled(bool $isEnabled) : void
Parameters
$isEnabled : bool

setFreeModeConverterConfig()

public setFreeModeConverterConfig(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>

setOpenedFlag()

Set value of flag 'OPENED'

public setOpenedFlag(bool $opened) : void
Parameters
$opened : bool

Opened Flag.

showCrmTypePopup()

public static showCrmTypePopup() : mixed

        
On this page

Search results