Bitrix API

EventCategoryService implements EventCategoryServiceInterface

FinalYes

Table of Contents

Interfaces

EventCategoryServiceInterface

Constants

OPEN_EVENT_CATEGORY_IM_ENTITY_TYPE  = 'CALENDAR_EVENT_CATEGORY'
Chat.ENTITY_TYPE property, which should set on channel connected with category CAUTION! It used in event subscribers

Methods

__construct()  : mixed
connectChannelToCategory()  : void
createChannel()  : int
getAvailableChannelsList()  : array<string|int, mixed>
Get all channels which created by user or user has access to moderate.
getChannelInfo()  : array<string|int, mixed>
getChannelUsers()  : array<string|int, mixed>
getThreadCommentsCount()  : int|null
hasAccess()  : bool
includeUserToChannel()  : bool
isChannelMuted()  : bool|null
isChannelPrivate()  : bool
isManagerOfChannel()  : bool
setMuteChannel()  : void
Change channel mute state for user.
updateChannel()  : void

Constants

OPEN_EVENT_CATEGORY_IM_ENTITY_TYPE

Chat.ENTITY_TYPE property, which should set on channel connected with category CAUTION! It used in event subscribers

public mixed OPEN_EVENT_CATEGORY_IM_ENTITY_TYPE = 'CALENDAR_EVENT_CATEGORY'
Tags
see
OnChatUserAddEntityTypeCalendarEventCategory

IM event

see
OnChatUserDeleteEntityTypeCalendarEventCategory

IM event It stored in every chat entity, connected to category.

Methods

connectChannelToCategory()

public connectChannelToCategory(int $channelId) : void
Parameters
$channelId : int

createChannel()

public createChannel(EventCategory $eventCategory, array<string|int, mixed> $userIds[, array<string|int, mixed> $departmentIds = [] ]) : int
Parameters
$eventCategory : EventCategory
$userIds : array<string|int, mixed>
$departmentIds : array<string|int, mixed> = []
Return values
int

getAvailableChannelsList()

Get all channels which created by user or user has access to moderate.

public getAvailableChannelsList(int $userId) : array<string|int, mixed>
Parameters
$userId : int
Return values
array<string|int, mixed>

getChannelInfo()

public getChannelInfo(int $channelId) : array<string|int, mixed>
Parameters
$channelId : int
Return values
array<string|int, mixed>

getChannelUsers()

public getChannelUsers(int $channelId) : array<string|int, mixed>
Parameters
$channelId : int
Return values
array<string|int, mixed>

getThreadCommentsCount()

public getThreadCommentsCount(int $threadId) : int|null
Parameters
$threadId : int
Return values
int|null

hasAccess()

public hasAccess(int $userId, int $channelId) : bool
Parameters
$userId : int
$channelId : int
Return values
bool

includeUserToChannel()

public includeUserToChannel(int $userId, int $channelId) : bool
Parameters
$userId : int
$channelId : int
Return values
bool

isChannelMuted()

public isChannelMuted(int $userId, int $channelId) : bool|null
Parameters
$userId : int
$channelId : int
Return values
bool|null

isChannelPrivate()

public isChannelPrivate(int $channelId) : bool
Parameters
$channelId : int
Return values
bool

isManagerOfChannel()

public isManagerOfChannel(int $userId, int $channelId) : bool
Parameters
$userId : int
$channelId : int
Return values
bool

setMuteChannel()

Change channel mute state for user.

public setMuteChannel(int $userId, int $channelId, bool $newMuteState) : void
Parameters
$userId : int
$channelId : int
$newMuteState : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results