Bitrix API

CollabAnalytics extends Analytics

Table of Contents

Constants

CATEGORY_COLLAB  = 'collab'
CATEGORY_COMMENTS_OPERATIONS  = 'comments_operations'
CATEGORY_INVITATION  = 'invitation'
CATEGORY_POSTS_OPERATIONS  = 'posts_operations'
ELEMENT_ADD_COMMENT_FIELD  = 'add_comment_field'
ELEMENT_COMMENT_BUTTON  = 'comment_button'
ELEMENT_QUOTE  = 'quote'
ELEMENT_REPLY_BUTTON  = 'reply_button'
EVENT_COMMENT_CREATE  = 'comment_create'
EVENT_COPY_LINK  = 'copy_invitation_link'
EVENT_INVITATION  = 'invitation'
EVENT_POST_CREATE  = 'post_create'
EVENT_SETTINGS_CHANGED  = 'edit_permissions'
EVENT_USER_ADDED  = 'add_user'
EVENT_USER_DELETED  = 'delete_user'
SECTION_COLLAB  = 'collab'
SECTION_EDITOR  = 'editor'
SECTION_FEED  = 'feed'
SECTION_PROJECT  = 'project'
STATUS_ERROR  = 'error'
STATUS_SUCCESS  = 'success'
TOOL_FEED  = 'feed'
TOOL_IM  = 'im'
TOOL_INVITATION  = 'invitation'
TYPE_ANNOUNCEMENT  = 'announcement'
TYPE_APPRECIATION  = 'appreciation'
TYPE_MODERATOR  = 'moderator'
TYPE_OWNER  = 'owner'
TYPE_POLL  = 'poll'
TYPE_POST  = 'post'

Methods

getCategories()  : array<string|int, mixed>
getCollabParameter()  : string
getElements()  : array<string|int, mixed>
getEvents()  : array<string|int, mixed>
getInstance()  : static
getSections()  : array<string|int, mixed>
getStatuses()  : array<string|int, mixed>
getSubSections()  : array<string|int, mixed>
getTools()  : array<string|int, mixed>
getTypes()  : array<string|int, mixed>
getUserParameter()  : string
getUserTypeParameter()  : string
onCommentAdd()  : void
onCopyLink()  : void
onMemberAdded()  : void
onMemberDeleted()  : void
onModeratorChanged()  : void
onOwnerChanged()  : void
onPostCreate()  : void
onSettingsChanged()  : void
onUserInvitation()  : void

Constants

CATEGORY_COMMENTS_OPERATIONS

public mixed CATEGORY_COMMENTS_OPERATIONS = 'comments_operations'

CATEGORY_POSTS_OPERATIONS

public mixed CATEGORY_POSTS_OPERATIONS = 'posts_operations'

ELEMENT_ADD_COMMENT_FIELD

public mixed ELEMENT_ADD_COMMENT_FIELD = 'add_comment_field'

ELEMENT_COMMENT_BUTTON

public mixed ELEMENT_COMMENT_BUTTON = 'comment_button'

ELEMENT_QUOTE

public mixed ELEMENT_QUOTE = 'quote'

ELEMENT_REPLY_BUTTON

public mixed ELEMENT_REPLY_BUTTON = 'reply_button'

EVENT_COMMENT_CREATE

public mixed EVENT_COMMENT_CREATE = 'comment_create'

EVENT_COPY_LINK

public mixed EVENT_COPY_LINK = 'copy_invitation_link'

EVENT_POST_CREATE

public mixed EVENT_POST_CREATE = 'post_create'

EVENT_SETTINGS_CHANGED

public mixed EVENT_SETTINGS_CHANGED = 'edit_permissions'

SECTION_FEED

public mixed SECTION_FEED = 'feed'

SECTION_PROJECT

public mixed SECTION_PROJECT = 'project'

STATUS_ERROR

public mixed STATUS_ERROR = 'error'

STATUS_SUCCESS

public mixed STATUS_SUCCESS = 'success'

TYPE_ANNOUNCEMENT

public mixed TYPE_ANNOUNCEMENT = 'announcement'

TYPE_APPRECIATION

public mixed TYPE_APPRECIATION = 'appreciation'

Methods

getCategories()

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

getCollabParameter()

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

getElements()

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

getEvents()

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

getInstance()

public static getInstance() : static
Return values
static

getSections()

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

getStatuses()

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

getSubSections()

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

getTools()

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

getTypes()

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

getUserParameter()

public getUserParameter(int $userId) : string
Parameters
$userId : int
Return values
string

getUserTypeParameter()

public getUserTypeParameter(int $userId) : string
Parameters
$userId : int
Return values
string

onCommentAdd()

public onCommentAdd(string|null $section, string|null $element, bool $status, string $type[, array<string|int, mixed> $params = [] ]) : void
Parameters
$section : string|null
$element : string|null
$status : bool
$type : string
$params : array<string|int, mixed> = []

onCopyLink()

public onCopyLink(int $userId, int $collabId) : void
Parameters
$userId : int
$collabId : int

onMemberAdded()

public onMemberAdded(int $userId, int $collabId) : void
Parameters
$userId : int
$collabId : int

onMemberDeleted()

public onMemberDeleted(int $userId, int $collabId) : void
Parameters
$userId : int
$collabId : int

onModeratorChanged()

public onModeratorChanged(int $userId, int $collabId) : void
Parameters
$userId : int
$collabId : int

onOwnerChanged()

public onOwnerChanged(int $userId, int $collabId) : void
Parameters
$userId : int
$collabId : int

onPostCreate()

public onPostCreate(string|null $section, string|null $element, bool $status, string $type[, array<string|int, mixed> $params = [] ]) : void
Parameters
$section : string|null
$element : string|null
$status : bool
$type : string
$params : array<string|int, mixed> = []

onSettingsChanged()

public onSettingsChanged(int $userId, int $collabId, string $optionName) : void
Parameters
$userId : int
$collabId : int
$optionName : string

onUserInvitation()

public onUserInvitation(int $userId, int $collabId, string $type) : void
Parameters
$userId : int
$collabId : int
$type : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results