Bitrix API

Delivery extends Base

Class Delivery

Table of Contents

Constants

ACTION_ADD  = 'ADD'
ACTION_UPDATE  = 'UPDATE'
COMMUNICATION_TYPE_EMAIL  = 'EMAIL'
COMMUNICATION_TYPE_PHONE  = 'PHONE'
COMMUNICATION_TYPE_UNDEFINED  = ''

Methods

addActivity()  : int|null
canAddCalendarEvents()  : bool
canCompleteOnView()  : mixed
canKeepCompletedInCalendar()  : mixed
canKeepReassignedInCalendar()  : mixed
canUseCalendarEvents()  : mixed
canUseCommunicationStatistics()  : mixed
canUseLiveFeedEvents()  : bool
checkCompletePermission()  : null|bool
checkFields()  : Result
checkForWaitingCompletion()  : bool
checkOwner()  : bool
checkPostponePermission()  : mixed
checkReadPermission()  : mixed
checkUpdatePermission()  : bool
Checks update permission for the activity for the given user.
className()  : string
createActivity()  : Result
createLiveFeedLog()  : int
deleteAssociatedEntity()  : Result
deleteByOwner()  : mixed
fillDefaultActivityFields()  : mixed
generateSubject()  : string
getActivityTitle()  : string
getAdditionalFieldsForEdit()  : mixed
getCommunicationType()  : mixed
getCompletionDeniedError()  : Error
getCustomViewLink()  : null|string
getDefaultPingOffsets()  : array<string|int, mixed>
Get ping settings
getDeliveryInfo()  : array<string|int, mixed>
getFieldsForEdit()  : array<string|int, mixed>
getId()  : mixed
getMoveBindingsLogMessageType()  : string|null
getName()  : mixed
getPlannerActions()  : array<string|int, mixed>
getPlannerTitle()  : string
getResultSources()  : mixed
getStatusAnchor()  : array<string|int, mixed>
Provider status anchor (active, inactive, settings URL etc.)
getSupportedCommunicationStatistics()  : mixed
getTypeDirections()  : mixed
getTypeId()  : mixed
getTypeName()  : bool
getTypes()  : array<string|int, mixed>
getTypesFilterPresets()  : array<string|int, mixed>
hasPlanner()  : bool
isActive()  : bool
Checks provider status.
isActivityEditable()  : bool
isActivitySearchSupported()  : bool
isCompletable()  : bool
Check if activity can be completed interactively by user.
isTask()  : bool
isTypeEditable()  : bool
isTypeValid()  : bool
makeTypeCode()  : string
makeTypeCodeNameList()  : array<string|int, mixed>
needSynchronizePingQueue()  : bool
onAfterAdd()  : mixed
Activity add callback
onAfterDelete()  : mixed
Activity delete callback
onAfterUpdate()  : mixed
Activity update callback
onBeforeComplete()  : mixed
Activity before complete callback
onDeliveryRequestCreated()  : void
onDeliveryRequestDeleted()  : void
onShipmentDeleted()  : void
postForm()  : Result
prepareHistoryItemData()  : null
This method provides some additional data to render timeline record about completing the activity.
prepareToolbarButtons()  : int
processCreation()  : mixed
Process activity creation.
processMovingToRecycleBin()  : mixed
processRestorationFromRecycleBin()  : mixed
rebindAssociatedEntity()  : mixed
renderEdit()  : null|string
renderView()  : string
saveAdditionalData()  : Result
setCompletionDeniedError()  : void
skipCalendarSync()  : bool
syncBadges()  : void
Add, update or remove badges associated with activity of this type
transferOwnership()  : mixed
tryPostpone()  : mixed
updateAssociatedEntity()  : Result

Constants

ACTION_ADD

public mixed ACTION_ADD = 'ADD'

ACTION_UPDATE

public mixed ACTION_UPDATE = 'UPDATE'

COMMUNICATION_TYPE_EMAIL

public mixed COMMUNICATION_TYPE_EMAIL = 'EMAIL'

COMMUNICATION_TYPE_PHONE

public mixed COMMUNICATION_TYPE_PHONE = 'PHONE'

COMMUNICATION_TYPE_UNDEFINED

public mixed COMMUNICATION_TYPE_UNDEFINED = ''

Methods

addActivity()

public static addActivity(Shipment $shipment) : int|null
Parameters
$shipment : Shipment
Return values
int|null

canAddCalendarEvents()

public static canAddCalendarEvents([string|null $providerTypeId = null ]) : bool
Parameters
$providerTypeId : string|null = null
Return values
bool

canCompleteOnView()

public static canCompleteOnView([mixed $providerTypeId = null ]) : mixed
Parameters
$providerTypeId : mixed = null

canKeepCompletedInCalendar()

public static canKeepCompletedInCalendar([mixed $providerTypeId = null ]) : mixed
Parameters
$providerTypeId : mixed = null

canKeepReassignedInCalendar()

public static canKeepReassignedInCalendar([mixed $providerTypeId = null ]) : mixed
Parameters
$providerTypeId : mixed = null

canUseCalendarEvents()

public static canUseCalendarEvents([mixed $providerTypeId = null ]) : mixed
Parameters
$providerTypeId : mixed = null

canUseCommunicationStatistics()

public static canUseCommunicationStatistics(mixed $statisticsType) : mixed
Parameters
$statisticsType : mixed

canUseLiveFeedEvents()

public static canUseLiveFeedEvents([null|string $providerTypeId = null ]) : bool
Parameters
$providerTypeId : null|string = null

Provider type id.

Return values
bool

checkCompletePermission()

public static checkCompletePermission(int $entityId, array<string|int, mixed> $activity, int $userId) : null|bool
Parameters
$entityId : int

Associated entity id.

$activity : array<string|int, mixed>

Activity data.

$userId : int

Target user id.

Return values
null|bool

checkFields()

public static checkFields(string $action, array<string|int, mixed> &$fields, int $id[, null|array<string|int, mixed> $params = null ]) : Result
Parameters
$action : string

Action ADD or UPDATE.

$fields : array<string|int, mixed>

Activity fields.

$id : int

Activity ID.

$params : null|array<string|int, mixed> = null

Additional parameters.

Return values
Result —

Check fields result.

checkForWaitingCompletion()

public static checkForWaitingCompletion(array<string|int, mixed> $activity) : bool
Parameters
$activity : array<string|int, mixed>

Activity data.

Return values
bool

checkOwner()

public static checkOwner() : bool
Return values
bool

checkPostponePermission()

public static checkPostponePermission(mixed $entityId, array<string|int, mixed> $activity, mixed $userId) : mixed
Parameters
$entityId : mixed
$activity : array<string|int, mixed>
$userId : mixed

checkReadPermission()

public static checkReadPermission(array<string|int, mixed> $activityFields[, mixed $userId = null ]) : mixed
Parameters
$activityFields : array<string|int, mixed>
$userId : mixed = null

checkUpdatePermission()

Checks update permission for the activity for the given user.

public static checkUpdatePermission(array<string|int, mixed> $activityFields[, int $userId = null ]) : bool
Parameters
$activityFields : array<string|int, mixed>

Fields of the activity.

$userId : int = null

Id of the user.

Return values
bool

className()

public static className() : string
Return values
string —

the fully qualified name of this class.

createActivity()

public createActivity(string $typeId, array<string|int, mixed> $fields[, array<string|int, mixed> $options = [] ]) : Result
Parameters
$typeId : string
$fields : array<string|int, mixed>
$options : array<string|int, mixed> = []
Return values
Result

createLiveFeedLog()

public static createLiveFeedLog(int $entityId, array<string|int, mixed> $activity, array<string|int, mixed> &$logFields) : int
Parameters
$entityId : int

Associated entity id.

$activity : array<string|int, mixed>

Activity data.

$logFields : array<string|int, mixed>

Live feed log fields.

Return values
int —

Log event id.

deleteAssociatedEntity()

public static deleteAssociatedEntity(int $entityId, array<string|int, mixed> $activity[, array<string|int, mixed> $options = array() ]) : Result
Parameters
$entityId : int

Associated entity id.

$activity : array<string|int, mixed>

Activity data.

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

Delete operation options.

Return values
Result —

Operation result.

deleteByOwner()

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

fillDefaultActivityFields()

public static fillDefaultActivityFields(array<string|int, mixed> &$activity) : mixed
Parameters
$activity : array<string|int, mixed>

generateSubject()

public static generateSubject([null|string $providerTypeId = null ][, int $direction = CCrmActivityDirection::Undefined ][, array<string|int, mixed>|null $replace = null ]) : string
Parameters
$providerTypeId : null|string = null

Provider type id.

$direction : int = CCrmActivityDirection::Undefined

Activity direction.

$replace : array<string|int, mixed>|null = null

Message replace templates.

Return values
string

getActivityTitle()

public static getActivityTitle(array<string|int, mixed> $activity) : string
Parameters
$activity : array<string|int, mixed>
Return values
string

getAdditionalFieldsForEdit()

public static getAdditionalFieldsForEdit(array<string|int, mixed> $activity) : mixed
Parameters
$activity : array<string|int, mixed>

getCommunicationType()

public static getCommunicationType([mixed $providerTypeId = null ]) : mixed
Parameters
$providerTypeId : mixed = null

getCompletionDeniedError()

public static getCompletionDeniedError() : Error
Return values
Error

getCustomViewLink()

public static getCustomViewLink(array<string|int, mixed> $activityFields) : null|string
Parameters
$activityFields : array<string|int, mixed>
Tags
inheritdoc
Return values
null|string

getDefaultPingOffsets()

Get ping settings

public static getDefaultPingOffsets([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []

List of the additional parameters to get ping settings

Return values
array<string|int, mixed>

getDeliveryInfo()

public static getDeliveryInfo(int $activityId) : array<string|int, mixed>
Parameters
$activityId : int
Return values
array<string|int, mixed>

getFieldsForEdit()

public static getFieldsForEdit(array<string|int, mixed> $activity) : array<string|int, mixed>
Parameters
$activity : array<string|int, mixed>

Activity data.

Return values
array<string|int, mixed> —

Fields.

getId()

public static getId() : mixed
Tags
inheritdoc

getMoveBindingsLogMessageType()

public static getMoveBindingsLogMessageType() : string|null
Return values
string|null

getName()

public static getName() : mixed
Tags
inheritdoc

getPlannerActions()

public static getPlannerActions([array<string|int, mixed> $params = null ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = null

Activity params.

Return values
array<string|int, mixed> —

Actions list. Example: array( array( 'NAME' => 'My activity', 'TYPE_ID' => \CCrmActivityType::Provider 'PROVIDER_ID' => '<PROVIDER_ID>', 'PROVIDER_TYPE_ID' => '<PROVIDER_TYPE_ID>', ) )

getPlannerTitle()

public static getPlannerTitle(array<string|int, mixed> $activity) : string
Parameters
$activity : array<string|int, mixed>

Activity data.

Return values
string —

Title.

getResultSources()

public static getResultSources() : mixed

getStatusAnchor()

Provider status anchor (active, inactive, settings URL etc.)

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

getSupportedCommunicationStatistics()

public static getSupportedCommunicationStatistics() : mixed

getTypeDirections()

public static getTypeDirections([mixed $providerTypeId = null ]) : mixed
Parameters
$providerTypeId : mixed = null

getTypeId()

public static getTypeId(array<string|int, mixed> $activity) : mixed
Parameters
$activity : array<string|int, mixed>
Tags
inheritdoc

getTypeName()

public static getTypeName([mixed $providerTypeId = null ][, mixed $direction = CCrmActivityDirection::Undefined ]) : bool
Parameters
$providerTypeId : mixed = null

Provider type id.

$direction : mixed = CCrmActivityDirection::Undefined

Activity direction.

Tags
inheritdoc
Return values
bool

getTypes()

public static getTypes() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed> —

Supported types list. Example: array( array( 'NAME' => 'My activity', // required 'PROVIDER_TYPE_ID' => 'MY_PROVIDER_TYPE_ID', // required 'DIRECTIONS' => array( \CCrmActivityDirection::Incoming => 'My activity (incoming)', \CCrmActivityDirection::Outgoing => 'My activity (outgoing)', ) // required ) )

getTypesFilterPresets()

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

Types filter presets list. Example: array( array( 'NAME' => 'Incoming activity', // required 'PROVIDER_TYPE_ID' => 'MY_TYPE', // optional 'DIRECTION' => \CCrmActivityDirection::Incoming // optional ), array( 'NAME' => 'Outgoing activity', // required 'PROVIDER_TYPE_ID' => 'MY_TYPE', // optional 'DIRECTION' => \CCrmActivityDirection::Outgoing // optional ) )

hasPlanner()

public static hasPlanner(array<string|int, mixed> $activity) : bool
Parameters
$activity : array<string|int, mixed>
Return values
bool

isActive()

Checks provider status.

public static isActive() : bool
Return values
bool

isActivityEditable()

public static isActivityEditable([array<string|int, mixed> $activity = [] ][, int $userId = 0 ]) : bool
Parameters
$activity : array<string|int, mixed> = []
$userId : int = 0
Return values
bool

isActivitySearchSupported()

public static isActivitySearchSupported() : bool
Return values
bool

isCompletable()

Check if activity can be completed interactively by user.

public static isCompletable() : bool
Return values
bool

isTask()

public static isTask() : bool
Return values
bool

isTypeEditable()

public static isTypeEditable([null|string $providerTypeId = null ][, int $direction = CCrmActivityDirection::Undefined ]) : bool
Parameters
$providerTypeId : null|string = null

Provider type id.

$direction : int = CCrmActivityDirection::Undefined

Activity direction.

Return values
bool

isTypeValid()

public static isTypeValid(string $typeId) : bool
Parameters
$typeId : string
Return values
bool

makeTypeCode()

public static makeTypeCode(array<string|int, mixed> $actFields) : string
Parameters
$actFields : array<string|int, mixed>
Return values
string

makeTypeCodeNameList()

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

needSynchronizePingQueue()

public static needSynchronizePingQueue(array<string|int, mixed> $activity) : bool
Parameters
$activity : array<string|int, mixed>
Return values
bool

onAfterAdd()

Activity add callback

public static onAfterAdd(array<string|int, mixed> $activityFields[, array<string|int, mixed>|null $params = null ]) : mixed
Parameters
$activityFields : array<string|int, mixed>
$params : array<string|int, mixed>|null = null

return null

onAfterDelete()

Activity delete callback

public static onAfterDelete(int $id, array<string|int, mixed> $activityFields[, array<string|int, mixed>|null $params = null ]) : mixed
Parameters
$id : int
$activityFields : array<string|int, mixed>
$params : array<string|int, mixed>|null = null

onAfterUpdate()

Activity update callback

public static onAfterUpdate(int $id, array<string|int, mixed> $changedFields, array<string|int, mixed> $oldFields, array<string|int, mixed> $newFields[, array<string|int, mixed>|null $params = null ]) : mixed
Parameters
$id : int
$changedFields : array<string|int, mixed>
$oldFields : array<string|int, mixed>
$newFields : array<string|int, mixed>
$params : array<string|int, mixed>|null = null

onBeforeComplete()

Activity before complete callback

public static onBeforeComplete(int $id, array<string|int, mixed> $activityFields[, array<string|int, mixed>|null $params = null ]) : mixed
Parameters
$id : int
$activityFields : array<string|int, mixed>
$params : array<string|int, mixed>|null = null

onDeliveryRequestCreated()

public static onDeliveryRequestCreated(Event $event) : void
Parameters
$event : Event

onDeliveryRequestDeleted()

public static onDeliveryRequestDeleted(Event $event) : void
Parameters
$event : Event

onShipmentDeleted()

public static onShipmentDeleted(int $shipmentId) : void
Parameters
$shipmentId : int

postForm()

public static postForm(array<string|int, mixed> &$activity, array<string|int, mixed> $formData) : Result
Parameters
$activity : array<string|int, mixed>

Activity data.

$formData : array<string|int, mixed>

Request post data.

Return values
Result —

Post result.

prepareHistoryItemData()

This method provides some additional data to render timeline record about completing the activity.

public static prepareHistoryItemData(mixed $historyFields) : null
Parameters
$historyFields : mixed
Return values
null

prepareToolbarButtons()

public static prepareToolbarButtons(array<string|int, mixed> &$buttons[, array<string|int, mixed> $params = null ]) : int
Parameters
$buttons : array<string|int, mixed>
$params : array<string|int, mixed> = null
Return values
int

processCreation()

Process activity creation.

public static processCreation(array<string|int, mixed> $activityFields[, array<string|int, mixed>|null $params = null ]) : mixed
Parameters
$activityFields : array<string|int, mixed>
$params : array<string|int, mixed>|null = null

processMovingToRecycleBin()

public static processMovingToRecycleBin(array<string|int, mixed> $activityFields[, array<string|int, mixed> $params = null ]) : mixed
Parameters
$activityFields : array<string|int, mixed>
$params : array<string|int, mixed> = null

processRestorationFromRecycleBin()

public static processRestorationFromRecycleBin(array<string|int, mixed> $activityFields[, array<string|int, mixed> $params = null ]) : mixed
Parameters
$activityFields : array<string|int, mixed>
$params : array<string|int, mixed> = null

rebindAssociatedEntity()

public static rebindAssociatedEntity(int $entityId, int $oldOwnerTypeId, int $newEntityTypeId, int $oldOwnerId, int $newOwnerId) : mixed
Parameters
$entityId : int

Associated (external) Entity id.

$oldOwnerTypeId : int

Old Entity Type id.

$newEntityTypeId : int

New Entity Type id.

$oldOwnerId : int

Old Entity id.

$newOwnerId : int

New Entity id.

renderEdit()

public static renderEdit(array<string|int, mixed> $activity) : null|string
Parameters
$activity : array<string|int, mixed>

Activity data.

Return values
null|string —

Rendered html edit.

renderView()

public static renderView(array<string|int, mixed> $activity) : string
Parameters
$activity : array<string|int, mixed>

Activity data.

Return values
string —

Rendered html view for specified mode.

saveAdditionalData()

public static saveAdditionalData(int $ID, array<string|int, mixed> $data) : Result
Parameters
$ID : int

Activity ID.

$data : array<string|int, mixed>

Activity data.

Return values
Result —

Save result.

setCompletionDeniedError()

public static setCompletionDeniedError(string $errorMessage) : void
Parameters
$errorMessage : string

skipCalendarSync()

public static skipCalendarSync(array<string|int, mixed> $activityFields[, array<string|int, mixed> $options = [] ]) : bool
Parameters
$activityFields : array<string|int, mixed>
$options : array<string|int, mixed> = []
Return values
bool

syncBadges()

Add, update or remove badges associated with activity of this type

public static syncBadges(int $activityId, array<string|int, mixed> $activityFields, array<string|int, mixed> $bindings) : void
Parameters
$activityId : int

Activity ID

$activityFields : array<string|int, mixed>

Activity

$bindings : array<string|int, mixed>

Activity bindings - badges should be synced only for these entities

transferOwnership()

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

tryPostpone()

public static tryPostpone(mixed $offset, array<string|int, mixed> $fields, array<string|int, mixed> &$updateFields[, mixed $checkPermissions = true ]) : mixed
Parameters
$offset : mixed
$fields : array<string|int, mixed>
$updateFields : array<string|int, mixed>
$checkPermissions : mixed = true

updateAssociatedEntity()

public static updateAssociatedEntity(int $entityId, array<string|int, mixed> $activity[, array<string|int, mixed> $options = array() ]) : Result
Parameters
$entityId : int

Associated entity id.

$activity : array<string|int, mixed>

Activity data.

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

Update operation options.

Return values
Result —

Operation result.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results