Bitrix API

Analytics extends Common

Table of Contents

Constants

COMMENT_CATEGORY  = 'comments_operations'
COMMENT_TYPE  = 'comment'
ELEMENT  = ['create_button' => 'create_button', 'quick_button' => 'quick_button', 'left_menu' => 'left_menu', 'horizontal_menu' => 'horizontal_menu', 'widget_menu' => 'widget_menu', 'title_click' => 'title_click', 'view_button' => 'view_button', 'context_menu' => 'context_menu', 'comment_context_menu' => 'comment_context_menu', 'send_button' => 'send_button', 'checkbox' => 'checkbox', 'complete_button' => 'complete_button', 'flows_grid_button' => 'flows_grid_button', 'flow_popup' => 'flow_popup', 'flow_selector' => 'flow_selector', 'section_button' => 'section_button', 'my_tasks_column' => 'my_tasks_column', 'create_demo_button' => 'create_demo_button', 'guide_button' => 'guide_button']
EVENT  = ['task_create' => 'task_create', 'task_view' => 'task_view', 'task_complete' => 'task_complete', 'comment_add' => 'comment_add', 'status_summary_add' => 'status_summary_add', 'subtask_add' => 'subtask_add', 'overdue_counters_on' => 'overdue_counters_on', 'comments_counters_on' => 'comments_counters_on', 'flow_create_start' => 'flow_create_start', 'flow_create_finish' => 'flow_create_finish', 'flows_view' => 'flows_view']
FLOW_CATEGORY  = 'flows'
SECTION  = ['tasks' => 'tasks', 'project' => 'project', 'scrum' => 'scrum', 'crm' => 'crm', 'feed' => 'feed', 'chat' => 'chat', 'mail' => 'mail', 'calendar' => 'calendar', 'user' => 'user', 'comment' => 'comment', 'flows' => 'flows', 'collab' => 'collab']
STATUS_ERROR  = 'error'
STATUS_SUCCESS  = 'success'
SUB_SECTION  = ['list' => 'list', 'kanban' => 'kanban', 'deadline' => 'deadline', 'planner' => 'planner', 'calendar' => 'calendar', 'gantt' => 'gantt', 'task_card' => 'task_card', 'efficiency' => 'efficiency', 'lead' => 'lead', 'deal' => 'deal', 'contact' => 'contact', 'company' => 'company', 'flows' => 'flows', 'flows_grid' => 'flows_grid', 'group_card' => 'group_card', 'flow_guide' => 'flow_guide']
TASK_CATEGORY  = 'task_operations'
TASK_TYPE  = 'task'
TOOL  = 'tasks'

Methods

getCollabParameter()  : string
getContext()  : string
getId()  : string|null
getInstance()  : static
getListStateInstance()  : CTaskListState|null
getUserId()  : int
getUserTypeParameter()  : string
getViewStateName()  : string
isScrumProject()  : bool
logToFile()  : void
onCommentAdd()  : void
onFirstProjectCreation()  : void
onFirstScrumCreation()  : void
onFirstTaskGridCreation()  : void
onFlowCreate()  : void
onFlowsView()  : void
onQrMobile()  : void
onStatusSummaryAdd()  : void
onTaskComplete()  : void
onTaskCreate()  : void
onTaskView()  : void
setContext()  : static
setGanttMode()  : static

Constants

COMMENT_CATEGORY

public mixed COMMENT_CATEGORY = 'comments_operations'

COMMENT_TYPE

public mixed COMMENT_TYPE = 'comment'

ELEMENT

public mixed ELEMENT = ['create_button' => 'create_button', 'quick_button' => 'quick_button', 'left_menu' => 'left_menu', 'horizontal_menu' => 'horizontal_menu', 'widget_menu' => 'widget_menu', 'title_click' => 'title_click', 'view_button' => 'view_button', 'context_menu' => 'context_menu', 'comment_context_menu' => 'comment_context_menu', 'send_button' => 'send_button', 'checkbox' => 'checkbox', 'complete_button' => 'complete_button', 'flows_grid_button' => 'flows_grid_button', 'flow_popup' => 'flow_popup', 'flow_selector' => 'flow_selector', 'section_button' => 'section_button', 'my_tasks_column' => 'my_tasks_column', 'create_demo_button' => 'create_demo_button', 'guide_button' => 'guide_button']

EVENT

public mixed EVENT = ['task_create' => 'task_create', 'task_view' => 'task_view', 'task_complete' => 'task_complete', 'comment_add' => 'comment_add', 'status_summary_add' => 'status_summary_add', 'subtask_add' => 'subtask_add', 'overdue_counters_on' => 'overdue_counters_on', 'comments_counters_on' => 'comments_counters_on', 'flow_create_start' => 'flow_create_start', 'flow_create_finish' => 'flow_create_finish', 'flows_view' => 'flows_view']

FLOW_CATEGORY

public mixed FLOW_CATEGORY = 'flows'

SECTION

public mixed SECTION = ['tasks' => 'tasks', 'project' => 'project', 'scrum' => 'scrum', 'crm' => 'crm', 'feed' => 'feed', 'chat' => 'chat', 'mail' => 'mail', 'calendar' => 'calendar', 'user' => 'user', 'comment' => 'comment', 'flows' => 'flows', 'collab' => 'collab']

STATUS_ERROR

public mixed STATUS_ERROR = 'error'

STATUS_SUCCESS

public mixed STATUS_SUCCESS = 'success'

SUB_SECTION

public mixed SUB_SECTION = ['list' => 'list', 'kanban' => 'kanban', 'deadline' => 'deadline', 'planner' => 'planner', 'calendar' => 'calendar', 'gantt' => 'gantt', 'task_card' => 'task_card', 'efficiency' => 'efficiency', 'lead' => 'lead', 'deal' => 'deal', 'contact' => 'contact', 'company' => 'company', 'flows' => 'flows', 'flows_grid' => 'flows_grid', 'group_card' => 'group_card', 'flow_guide' => 'flow_guide']

TASK_CATEGORY

public mixed TASK_CATEGORY = 'task_operations'

Methods

getCollabParameter()

public getCollabParameter(int $collabId) : string
Parameters
$collabId : int
Return values
string

getContext()

public getContext() : string
Return values
string

getId()

public getId() : string|null
Return values
string|null

getInstance()

public static getInstance([int $userId = 0 ][, int|null $groupId = 0 ][, string|null $id = null ]) : static
Parameters
$userId : int = 0
$groupId : int|null = 0
$id : string|null = null
Return values
static

getListStateInstance()

public getListStateInstance() : CTaskListState|null
Return values
CTaskListState|null

getUserId()

public getUserId() : int
Return values
int

getUserTypeParameter()

public getUserTypeParameter() : string
Return values
string

getViewStateName()

public getViewStateName() : string
Return values
string

isScrumProject()

public isScrumProject() : bool
Return values
bool

logToFile()

public logToFile(string $action[, string $tag = '' ][, string $label = '' ][, string $actionType = '' ][, int|null $userId = null ]) : void
Parameters
$action : string
$tag : string = ''
$label : string = ''
$actionType : string = ''
$userId : int|null = null

onCommentAdd()

public onCommentAdd([string $section = self::SECTION['tasks'] ][, array<string|int, mixed> $params = [] ]) : void
Parameters
$section : string = self::SECTION['tasks']
$params : array<string|int, mixed> = []
Tags
throws
ArgumentException

onFirstProjectCreation()

public onFirstProjectCreation() : void

onFirstScrumCreation()

public onFirstScrumCreation() : void

onFirstTaskGridCreation()

public onFirstTaskGridCreation() : void

onFlowCreate()

public onFlowCreate(string $event, string $section[, string|null $element = null ][, string|null $subSection = null ][, array<string|int, mixed> $params = [] ]) : void
Parameters
$event : string
$section : string
$element : string|null = null
$subSection : string|null = null
$params : array<string|int, mixed> = []

onFlowsView()

public onFlowsView(string $section[, string|null $element = null ][, string|null $subSection = null ][, array<string|int, mixed> $params = [] ]) : void
Parameters
$section : string
$element : string|null = null
$subSection : string|null = null
$params : array<string|int, mixed> = []

onStatusSummaryAdd()

public onStatusSummaryAdd([string|null $element = null ]) : void
Parameters
$element : string|null = null
Tags
throws
ArgumentException

onTaskComplete()

public onTaskComplete(string $section[, string|null $subSection = null ][, string|null $element = null ]) : void
Parameters
$section : string
$subSection : string|null = null
$element : string|null = null
Tags
throws
ArgumentException

onTaskCreate()

public onTaskCreate(string $category, string $event, string|null $section, string|null $element, string|null $subSection, bool $status[, array<string|int, mixed> $params = [] ]) : void
Parameters
$category : string
$event : string
$section : string|null
$element : string|null
$subSection : string|null
$status : bool
$params : array<string|int, mixed> = []
Tags
throws
ArgumentException

onTaskView()

public onTaskView(string $section[, string|null $element = null ][, string|null $subSection = null ][, array<string|int, mixed> $params = [] ]) : void
Parameters
$section : string
$element : string|null = null
$subSection : string|null = null
$params : array<string|int, mixed> = []
Tags
throws
ArgumentException

setContext()

public setContext(string $context) : static
Parameters
$context : string
Return values
static

setGanttMode()

public setGanttMode(bool $isGantt) : static
Parameters
$isGantt : bool
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results