Bitrix API

CommentChat extends GroupChat

Chat for comments

Constants

AVAILABLE_PARAMS = ['type', 'entityType', 'entityId', 'entityData1', 'entityData2', 'entityData3', 'title', 'description', 'searchable', 'color', 'ownerId', 'users', 'managers', 'manageUsersAdd', 'manageUsersDelete', 'manageUi', 'manageSettings', 'disappearingTime', 'manageMessages', 'avatar', 'conferencePassword', 'memberEntities']
ENTITY_TYPE_FAVORITE = 'FAVORITE'
ENTITY_TYPE_GENERAL = 'GENERAL'
ENTITY_TYPE_GENERAL_CHANNEL = 'GENERAL_CHANNEL'
ENTITY_TYPE_LINE = 'LINES'
ENTITY_TYPE_LIVECHAT = 'LIVECHAT'
ENTITY_TYPE_VIDEOCONF = 'VIDEOCONF'
IM_TYPE_CHANNEL = 'N'
IM_TYPE_CHAT = 'C'
IM_TYPE_COLLAB = 'B'
IM_TYPE_COMMENT = 'T'
IM_TYPE_COPILOT = 'A'
IM_TYPE_OPEN = 'O'
IM_TYPE_OPEN_CHANNEL = 'J'
IM_TYPE_OPEN_LINE = 'L'
IM_TYPE_PRIVATE = 'P'
IM_TYPE_SYSTEM = 'S'
IM_TYPES = [self::IM_TYPE_PRIVATE, self::IM_TYPE_CHAT, self::IM_TYPE_COMMENT, self::IM_TYPE_OPEN_LINE, self::IM_TYPE_SYSTEM, self::IM_TYPE_CHANNEL, self::IM_TYPE_OPEN_CHANNEL, self::IM_TYPE_OPEN, self::IM_TYPE_COPILOT, self::IM_TYPE_COLLAB]
IM_TYPES_TRANSLATE = ['PRIVATE' => self::IM_TYPE_PRIVATE, 'CHAT' => self::IM_TYPE_CHAT, 'COMMENT' => self::IM_TYPE_COMMENT, 'OPENLINE' => self::IM_TYPE_OPEN_LINE, 'SYSTEM' => self::IM_TYPE_SYSTEM, 'NOTIFY' => self::IM_TYPE_SYSTEM, 'CHANNEL' => self::IM_TYPE_CHANNEL, 'OPEN_CHANNEL' => self::IM_TYPE_OPEN_CHANNEL, 'OPEN' => self::IM_TYPE_OPEN, 'COPILOT' => self::IM_TYPE_COPILOT, 'COLLAB' => self::IM_TYPE_COLLAB]
MANAGE_RIGHTS_MANAGERS = 'MANAGER'
MANAGE_RIGHTS_MEMBER = 'MEMBER'
MANAGE_RIGHTS_NONE = 'NONE'
MANAGE_RIGHTS_OWNER = 'OWNER'
ROLE_GUEST = 'GUEST'
ROLE_MANAGER = 'MANAGER'
ROLE_MEMBER = 'MEMBER'
ROLE_NONE = 'NONE'
ROLE_OWNER = 'OWNER'

Methods

__construct() : mixed
add() : Result
addManagers() : self
addUsers() : self
allowMention() : bool: Allows to send mention notification.
canDo() : bool
changeAuthor() : void
changeManagersByMap() : self
checkAccess() : Result
checkAllowedAction() : bool
checkColor() : Result
checkTitle() : Result
cleanAccessCache() : void
cleanCache() : void
create() : Result
createChatIfNotExists() : self
delete() : Result
deleteChat() : Result
deleteManagers() : self
deleteMessage() : Result
deleteUser() : Result
fill() : static: Fills object's fields with provided values.
fillActual() : self
fillNonCachedData() : self
fillSelfRelations() : void
filterUsersToMention() : array<string|int, mixed>
find() : Result: Looks for chat by its parameters.
get() : Result
getAliasName() : string|null
getAuthor() : User
getAuthorId() : int|null
getAvatar() : string
getAvatarId() : int|null
getBotInChat() : array<string|int, mixed>
getCallNumber() : string|null
getCallType() : int|null
getCanPostList() : array<string|int, mixed>
getChatId() : int|null
getChatParams() : Params|null
getColor() : string|null
getContext() : Context: Returns the local or global context for the action.
getCounterType() : CounterType
getDataClass() : string: Returns ORM tablet class name.
getDataEntity() : EntityObject
getDateCreate() : DateTime|null
getDefaultColor() : string
getDefaultDateCreate() : DateTime
getDefaultExtranet() : bool
getDefaultLastMessageStatus() : string
getDefaultManageMessages() : string
getDefaultManageSettings() : string
getDefaultManageUI() : string
getDefaultManageUsersAdd() : string
getDefaultManageUsersDelete() : string
getDescription() : string|null
getDialogContextId() : string|null
getDialogId() : string|null
getDialogIdByContextId() : string
getDisappearingTime() : int|null
getDiskFolder() : Folder|null
getDiskFolderId() : int|null
getDisplayedTitle() : string|null
getEntityData1() : string|null
getEntityData2() : string|null
getEntityData3() : string|null
getEntityId() : string|null
getEntityLink() : EntityLink
getEntityType() : string|null
getExtendedType() : string
getExtranet() : bool|null
getId() : int|null: Returns the id of the entity
getInstance() : static
getLastFileId() : int
getLastMessageId() : int|null
getLastMessageStatus() : string|null
getLastMessageViews() : array<string|int, mixed>
getLastMessageViewsByGroups() : array<string|int, mixed>
getLoadContextMessage() : Message
getManageMessages() : string|null
getManageSettings() : string|null
getManageUI() : string|null
getManageUsersAdd() : string|null
getManageUsersDelete() : string|null
getMarkedId() : int
getMessage() : Message|null
getMessageCount() : int
getMessageRegistry() : Registry<string|int, Message>
getMultidialogData() : array<string|int, mixed>
getOrCreateDiskFolder() : Folder|null
getParentChat() : Chat
getParentChatId() : int|null
getParentMessage() : Message|null
getParentMessageId() : int
getPermissions() : array<string|int, mixed>
getPinMessageId() : int|null
getPopupData() : PopupData: Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
getPrevMessageId() : int
getPrimaryId() : int|null
getRegistry() : Registry|null: Return link of the object's registry.
getRelationByReason() : RelationCollection
getRelationByUserId() : Relation|null
getRelationFacade() : ChatRelations|null
getRelations() : RelationCollection
getRelationsByUserIds() : RelationCollection
getRelationsForSendMessage() : RelationCollection
getRestEntityName() : string: Returns the name of the entity that will be used in the rest response
getRole() : string
getSelfRelation() : Relation|null
getSharedChatsWithUser() : array<string|int, static>
getStartId() : int
getStorageId() : int
getTitle() : string|null
getType() : string
getUserCount() : int
getUserIds() : array<string|int, mixed>|null
isChanged() : bool: Tells true if object has been changed.
isDeleted() : bool: Tells true if object marked to drop.
isExist() : bool
isNew() : bool
join() : Chat
linkToStructureNodes() : void
load() : Result
loadPhrases() : void: Lazy load message's context phrases.
markChanged() : static: Marks object changed.
markDrop() : static: Marks object to drop on save.
needToSendPublicPull() : bool
onAfterOrmUpdate() : self
prepareAliasToLoad() : string|null
prepareFields() : Result
read() : Result
readAllChats() : Result
readAllMessages() : Result
readMessages() : Result
readTo() : Result
save() : Result: Saves object state into database.
sendMessage() : SendResult
sendMessageUpdateAvatar() : void
sendPushUpdateMessage() : void
setAliasName() : self
setAuthorId() : self
setAvatarId() : self
setCallNumber() : self
setCallType() : self
setCanPost() : $this
setChatParams() : self
setColor() : self
setContext() : self
setContextUser() : self
setDateCreate() : self
setDescription() : self
setDialogId() : self
setDisappearingTime() : self
setDiskFolderId() : self
setEntityData1() : self
setEntityData2() : self
setEntityData3() : self
setEntityId() : self
setEntityType() : self
setExtranet() : self
setLastMessageId() : self
setLastMessageStatus() : self
setManageMessages() : self
setManagers() : self
setManageSettings() : self
setManageUI() : self
setManageUsersAdd() : self
setManageUsersDelete() : self
setMessageCount() : self
setParentChat() : self
setParentChatId() : self
setParentMessage() : self
setParentMessageId() : self
setPinMessageId() : self
setPrevMessageId() : self
setPrimaryId() : self
setRegistry() : self
setRelations() : self
setTitle() : self
setType() : self
setUserCount() : self
startRecordVoice() : void
subscribe() : Result
subscribeUsers() : Result
toArray() : array<string|int, mixed>: Returns object state as array.
toPullFormat() : array<string|int, mixed>
toRestFormat() : array<string|int, mixed>|null: Returns an array in JSON like format to return the entity as a rest response.
unlinkStructureNodes() : void
updateMessage() : Result
updateStateAfterOrmEvent() : void
validateColor() : Result
withContext() : static: Provides local context for the action.
withContextUser() : static: Provides local context for the action.

AVAILABLE_PARAMS


    public
        mixed
    AVAILABLE_PARAMS
    = ['type', 'entityType', 'entityId', 'entityData1', 'entityData2', 'entityData3', 'title', 'description', 'searchable', 'color', 'ownerId', 'users', 'managers', 'manageUsersAdd', 'manageUsersDelete', 'manageUi', 'manageSettings', 'disappearingTime', 'manageMessages', 'avatar', 'conferencePassword', 'memberEntities']

ENTITY_TYPE_FAVORITE


    public
        mixed
    ENTITY_TYPE_FAVORITE
    = 'FAVORITE'

ENTITY_TYPE_GENERAL


    public
        mixed
    ENTITY_TYPE_GENERAL
    = 'GENERAL'

ENTITY_TYPE_GENERAL_CHANNEL


    public
        mixed
    ENTITY_TYPE_GENERAL_CHANNEL
    = 'GENERAL_CHANNEL'

ENTITY_TYPE_LINE


    public
        mixed
    ENTITY_TYPE_LINE
    = 'LINES'

ENTITY_TYPE_LIVECHAT


    public
        mixed
    ENTITY_TYPE_LIVECHAT
    = 'LIVECHAT'

ENTITY_TYPE_VIDEOCONF


    public
        mixed
    ENTITY_TYPE_VIDEOCONF
    = 'VIDEOCONF'

IM_TYPE_CHANNEL


    public
        mixed
    IM_TYPE_CHANNEL
    = 'N'

IM_TYPE_CHAT


    public
        mixed
    IM_TYPE_CHAT
    = 'C'

IM_TYPE_COLLAB


    public
        mixed
    IM_TYPE_COLLAB
    = 'B'

IM_TYPE_COMMENT


    public
        mixed
    IM_TYPE_COMMENT
    = 'T'

IM_TYPE_COPILOT


    public
        mixed
    IM_TYPE_COPILOT
    = 'A'

IM_TYPE_OPEN


    public
        mixed
    IM_TYPE_OPEN
    = 'O'

IM_TYPE_OPEN_CHANNEL


    public
        mixed
    IM_TYPE_OPEN_CHANNEL
    = 'J'

IM_TYPE_OPEN_LINE


    public
        mixed
    IM_TYPE_OPEN_LINE
    = 'L'

IM_TYPE_PRIVATE


    public
        mixed
    IM_TYPE_PRIVATE
    = 'P'

IM_TYPE_SYSTEM


    public
        mixed
    IM_TYPE_SYSTEM
    = 'S'

IM_TYPES


    public
        mixed
    IM_TYPES
    = [self::IM_TYPE_PRIVATE, self::IM_TYPE_CHAT, self::IM_TYPE_COMMENT, self::IM_TYPE_OPEN_LINE, self::IM_TYPE_SYSTEM, self::IM_TYPE_CHANNEL, self::IM_TYPE_OPEN_CHANNEL, self::IM_TYPE_OPEN, self::IM_TYPE_COPILOT, self::IM_TYPE_COLLAB]

IM_TYPES_TRANSLATE


    public
        mixed
    IM_TYPES_TRANSLATE
    = ['PRIVATE' => self::IM_TYPE_PRIVATE, 'CHAT' => self::IM_TYPE_CHAT, 'COMMENT' => self::IM_TYPE_COMMENT, 'OPENLINE' => self::IM_TYPE_OPEN_LINE, 'SYSTEM' => self::IM_TYPE_SYSTEM, 'NOTIFY' => self::IM_TYPE_SYSTEM, 'CHANNEL' => self::IM_TYPE_CHANNEL, 'OPEN_CHANNEL' => self::IM_TYPE_OPEN_CHANNEL, 'OPEN' => self::IM_TYPE_OPEN, 'COPILOT' => self::IM_TYPE_COPILOT, 'COLLAB' => self::IM_TYPE_COLLAB]

MANAGE_RIGHTS_MANAGERS


    public
        mixed
    MANAGE_RIGHTS_MANAGERS
    = 'MANAGER'

MANAGE_RIGHTS_MEMBER


    public
        mixed
    MANAGE_RIGHTS_MEMBER
    = 'MEMBER'

MANAGE_RIGHTS_NONE


    public
        mixed
    MANAGE_RIGHTS_NONE
    = 'NONE'

MANAGE_RIGHTS_OWNER


    public
        mixed
    MANAGE_RIGHTS_OWNER
    = 'OWNER'

ROLE_GUEST


    public
        mixed
    ROLE_GUEST
    = 'GUEST'

ROLE_MANAGER


    public
        mixed
    ROLE_MANAGER
    = 'MANAGER'

ROLE_MEMBER


    public
        mixed
    ROLE_MEMBER
    = 'MEMBER'

ROLE_NONE


    public
        mixed
    ROLE_NONE
    = 'NONE'

ROLE_OWNER


    public
        mixed
    ROLE_OWNER
    = 'OWNER'

__construct()


    public
                    __construct([int|array<string|int, mixed>|EO_Chat|null $source = null ]) : mixed

Parameters

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

add()


    public
                    add(array<string|int, mixed> $params[, Context|null $context = null ]) : Result

Parameters

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

Return values

Result

addManagers()


    public
                    addManagers(array<string|int, mixed> $userIds[, bool $sendPush = true ]) : self

Parameters

$userIds : array<string|int, mixed>
$sendPush : bool = true

Return values

self

addUsers()


    public
                    addUsers(array<string|int, mixed> $userIds[, AddUsersConfig $config = new AddUsersConfig() ]) : self

Parameters

$userIds : array<string|int, mixed>
$config : AddUsersConfig = new AddUsersConfig()

Return values

self

allowMention()

Allows to send mention notification.


    public
                    allowMention() : bool

Return values

bool

canDo()


    public
                    canDo(Action $action[, mixed $target = null ]) : bool

Parameters

$action : Action
$target : mixed = null

Return values

bool

changeAuthor()


    public
                    changeAuthor() : void

changeManagersByMap()


    public
                    changeManagersByMap(array<string|int, bool> $usersMap[, bool $sendPush = true ]) : self

Parameters

$usersMap : array<string|int, bool>
$sendPush : bool = true

Return values

self

checkAccess()


    public
        final            checkAccess([int|User|null $user = null ]) : Result

Parameters

$user : int|User|null = null

Return values

Result

checkAllowedAction()


    public
                    checkAllowedAction(string $action) : bool

Parameters

$action : string

Return values

bool

checkColor()


    public
                    checkColor() : Result

Return values

Result

checkTitle()


    public
                    checkTitle() : Result

Return values

Result

cleanAccessCache()


    public
            static        cleanAccessCache(int $chatId) : void

Parameters

$chatId : int

cleanCache()


    public
            static        cleanCache(int $id[, bool $cleanStaticCache = true ]) : void

Parameters

$id : int
$cleanStaticCache : bool = true

create()


    public
            static        create(Message $message) : Result

Parameters

$message : Message

Return values

Result

createChatIfNotExists()


    public
                    createChatIfNotExists(array<string|int, mixed> $params) : self

Parameters

$params : array<string|int, mixed>

Return values

self

delete()


    public
                    delete() : Result

Return values

Result

deleteChat()


    public
                    deleteChat() : Result

Return values

Result

deleteManagers()


    public
                    deleteManagers(array<string|int, mixed> $userIds[, bool $sendPush = true ]) : self

Parameters

$userIds : array<string|int, mixed>
$sendPush : bool = true

Return values

self

deleteMessage()


    public
                    deleteMessage(Message $message) : Result

Parameters

$message : Message

Return values

Result

deleteUser()


    public
                    deleteUser(int $userId[, DeleteUserConfig $config = new DeleteUserConfig() ]) : Result

Parameters

$userId : int
$config : DeleteUserConfig = new DeleteUserConfig()

Return values

Result

fill()

Fills object's fields with provided values.


    public
                    fill(array<string|int, mixed> $source) : static

Parameters

$source : array<string|int, mixed>

Return values

static

fillActual()


    public
                    fillActual(array<string|int, mixed> $fieldsToFill) : self

Parameters

$fieldsToFill : array<string|int, mixed>

Return values

self

fillNonCachedData()


    public
                    fillNonCachedData() : self

Return values

self

fillSelfRelations()


    public
            static        fillSelfRelations(array<string|int, static> $chats[, int|null $userId = null ]) : void

Parameters

$chats : array<string|int, static>
$userId : int|null = null

filterUsersToMention()


    public
                    filterUsersToMention(array<string|int, mixed> $userIds) : array<string|int, mixed>

Parameters

$userIds : array<string|int, mixed>

Return values

array<string|int, mixed>

find()

Looks for chat by its parameters.


    public
            static        find(array<string|int, mixed> $params[, Context|null $context = null ]) : Result

Parameters

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

Return values

Result

get()


    public
            static        get(Message $message[, bool $createIfNotExists = true ]) : Result

Parameters

$message : Message
$createIfNotExists : bool = true

Return values

Result

getAliasName()


    public
                    getAliasName() : string|null

Return values

string|null

getAuthor()


    public
                    getAuthor() : User

Return values

User

getAuthorId()


    public
                    getAuthorId() : int|null

Return values

int|null

getAvatar()


    public
                    getAvatar([bool $addBlankPicture = false ][, bool $withDomain = false ]) : string

Parameters

$addBlankPicture : bool = false
$withDomain : bool = false

Return values

string

getAvatarId()


    public
                    getAvatarId() : int|null

Return values

int|null

getBotInChat()


    public
                    getBotInChat() : array<string|int, mixed>

Return values

array<string|int, mixed>

getCallNumber()


    public
                    getCallNumber() : string|null

Return values

string|null

getCallType()


    public
                    getCallType() : int|null

Return values

int|null

getCanPostList()


    public
            static        getCanPostList() : array<string|int, mixed>

Return values

array<string|int, mixed>

getChatId()


    public
                    getChatId() : int|null

Return values

int|null

getChatParams()


    public
                    getChatParams() : Params|null

Return values

Params|null

getColor()


    public
                    getColor([bool $forRest = false ]) : string|null

Parameters

$forRest : bool = false

Return values

string|null

getContext()

Returns the local or global context for the action.


    public
                    getContext() : Context

Return values

Context

getCounterType()


    public
                    getCounterType() : CounterType

Return values

CounterType

getDataClass()

Returns ORM tablet class name.


    public
            static        getDataClass() : string

Return values

string

getDataEntity()


    public
                    getDataEntity() : EntityObject

Return values

EntityObject

getDateCreate()


    public
                    getDateCreate() : DateTime|null

Return values

DateTime|null

getDefaultColor()


    public
                    getDefaultColor() : string

Return values

string

getDefaultDateCreate()


    public
                    getDefaultDateCreate() : DateTime

Return values

DateTime

getDefaultExtranet()


    public
                    getDefaultExtranet() : bool

Return values

bool

getDefaultLastMessageStatus()


    public
                    getDefaultLastMessageStatus() : string

Return values

string

getDefaultManageMessages()


    public
                    getDefaultManageMessages() : string

Return values

string

getDefaultManageSettings()


    public
                    getDefaultManageSettings() : string

Return values

string

getDefaultManageUI()


    public
                    getDefaultManageUI() : string

Return values

string

getDefaultManageUsersAdd()


    public
                    getDefaultManageUsersAdd() : string

Return values

string

getDefaultManageUsersDelete()


    public
                    getDefaultManageUsersDelete() : string

Return values

string

getDescription()


    public
                    getDescription() : string|null

Return values

string|null

getDialogContextId()


    public
                    getDialogContextId() : string|null

Return values

string|null

getDialogId()


    public
                    getDialogId() : string|null

Return values

string|null

getDialogIdByContextId()


    public
            static        getDialogIdByContextId(string $contextId[, int|null $userId = null ]) : string

Parameters

$contextId : string
$userId : int|null = null

Return values

string

getDisappearingTime()


    public
                    getDisappearingTime() : int|null

Return values

int|null

getDiskFolder()


    public
                    getDiskFolder() : Folder|null

Return values

Folder|null

getDiskFolderId()


    public
                    getDiskFolderId() : int|null

Return values

int|null

getDisplayedTitle()


    public
                    getDisplayedTitle() : string|null

Return values

string|null

getEntityData1()


    public
                    getEntityData1() : string|null

Return values

string|null

getEntityData2()


    public
                    getEntityData2() : string|null

Return values

string|null

getEntityData3()


    public
                    getEntityData3() : string|null

Return values

string|null

getEntityId()


    public
                    getEntityId() : string|null

Return values

string|null

getEntityLink()


    public
                    getEntityLink() : EntityLink

Return values

EntityLink

getEntityType()


    public
                    getEntityType() : string|null

Return values

string|null

getExtendedType()


    public
                    getExtendedType([bool $forRest = true ]) : string

Parameters

$forRest : bool = true

Return values

string

getExtranet()


    public
                    getExtranet() : bool|null

Return values

bool|null

getId()

Returns the id of the entity


    public
                    getId() : int|null

Return values

int|null

getInstance()


    public
            static        getInstance(int|null $chatId) : static

Parameters

$chatId : int|null

Return values

static

getLastFileId()


    public
                    getLastFileId() : int

Return values

int

getLastMessageId()


    public
                    getLastMessageId() : int|null

Return values

int|null

getLastMessageStatus()


    public
                    getLastMessageStatus() : string|null

Return values

string|null

getLastMessageViews()


    public
                    getLastMessageViews() : array<string|int, mixed>

Return values

array<string|int, mixed>

getLastMessageViewsByGroups()


    public
                    getLastMessageViewsByGroups() : array<string|int, mixed>

Return values

array<string|int, mixed>

getLoadContextMessage()


    public
                    getLoadContextMessage([bool $ignoreMark = false ]) : Message

Parameters

$ignoreMark : bool = false

Return values

Message

getManageMessages()


    public
                    getManageMessages() : string|null

Return values

string|null

getManageSettings()


    public
                    getManageSettings() : string|null

Return values

string|null

getManageUI()


    public
                    getManageUI() : string|null

Return values

string|null

getManageUsersAdd()


    public
                    getManageUsersAdd() : string|null

Return values

string|null

getManageUsersDelete()


    public
                    getManageUsersDelete() : string|null

Return values

string|null

getMarkedId()


    public
                    getMarkedId() : int

Return values

int

getMessage()


    public
                    getMessage(int $messageId) : Message|null

Parameters

$messageId : int

Return values

Message|null

getMessageCount()


    public
                    getMessageCount() : int

Return values

int

getMessageRegistry()


    public
                    getMessageRegistry() : Registry<string|int, Message>

Return values

Registry<string|int, Message>

getMultidialogData()


    public
                    getMultidialogData() : array<string|int, mixed>

Return values

array<string|int, mixed>

getOrCreateDiskFolder()


    public
                    getOrCreateDiskFolder() : Folder|null

Return values

Folder|null

getParentChat()


    public
                    getParentChat() : Chat

Return values

Chat

getParentChatId()


    public
                    getParentChatId() : int|null

Return values

int|null

getParentMessage()


    public
                    getParentMessage() : Message|null

Return values

Message|null

getParentMessageId()


    public
                    getParentMessageId() : int

Return values

int

getPermissions()


    public
                    getPermissions() : array<string|int, mixed>

Return values

array<string|int, mixed>

getPinMessageId()


    public
                    getPinMessageId() : int|null

Return values

int|null

getPopupData()

Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.


    public
                    getPopupData([array<string|int, mixed> $excludedList = [] ]) : PopupData

Parameters

$excludedList : array<string|int, mixed> = []

Return values

PopupData

getPrevMessageId()


    public
                    getPrevMessageId() : int

Return values

int

getPrimaryId()


    public
                    getPrimaryId() : int|null

Return values

int|null

getRegistry()

Return link of the object's registry.


    public
                    getRegistry() : Registry|null

Return values

Registry|null

getRelationByReason()


    public
                    getRelationByReason(Reason $reason) : RelationCollection

Parameters

$reason : Reason

Return values

RelationCollection

getRelationByUserId()


    public
                    getRelationByUserId(int $userId) : Relation|null

Parameters

$userId : int

Return values

Relation|null

getRelationFacade()


    public
                    getRelationFacade() : ChatRelations|null

Return values

ChatRelations|null

getRelations()


    public
                    getRelations() : RelationCollection

Return values

RelationCollection

getRelationsByUserIds()


    public
                    getRelationsByUserIds(array<string|int, mixed> $userIds) : RelationCollection

Parameters

$userIds : array<string|int, mixed>

Return values

RelationCollection

getRelationsForSendMessage()


    public
                    getRelationsForSendMessage() : RelationCollection

Return values

RelationCollection

getRestEntityName()

Returns the name of the entity that will be used in the rest response


    public
            static        getRestEntityName() : string

Return values

string

getRole()


    public
                    getRole() : string

Return values

string

getSelfRelation()


    public
                    getSelfRelation() : Relation|null

Return values

Relation|null

getSharedChatsWithUser()


    public
            static        getSharedChatsWithUser(int $userId[, int $limit = 50 ][, int $offset = 0 ][, int $currentUserId = null ]) : array<string|int, static>

Parameters

$userId : int
$limit : int = 50
$offset : int = 0
$currentUserId : int = null

Return values

array<string|int, static>

getStartId()


    public
                    getStartId([int|null $userId = null ]) : int

Parameters

$userId : int|null = null

Return values

int

getStorageId()


    public
                    getStorageId() : int

Return values

int

getTitle()


    public
                    getTitle() : string|null

Return values

string|null

getType()


    public
                    getType() : string

Return values

string

getUserCount()


    public
                    getUserCount() : int

Return values

int

getUserIds()


    public
                    getUserIds() : array<string|int, mixed>|null

Return values

array<string|int, mixed>|null

isChanged()

Tells true if object has been changed.


    public
                    isChanged() : bool

Return values

bool

isDeleted()

Tells true if object marked to drop.


    public
                    isDeleted() : bool

Return values

bool

isExist()


    public
                    isExist() : bool

Return values

bool

isNew()


    public
                    isNew() : bool

Return values

bool

join()


    public
                    join([bool $withMessage = true ]) : Chat

Parameters

$withMessage : bool = true

Return values

Chat

linkToStructureNodes()


    public
                    linkToStructureNodes(array<string|int, mixed> $structureNodes) : void

Parameters

$structureNodes : array<string|int, mixed>

load()


    public
                    load(int|array<string|int, mixed>|EntityObject $source) : Result

Parameters

$source : int|array<string|int, mixed>|EntityObject

Return values

Result

loadPhrases()

Lazy load message's context phrases.


    public
            static        loadPhrases() : void

markChanged()

Marks object changed.


    public
                    markChanged([bool|null $state = null ]) : static

Parameters

$state : bool|null = null

Return values

static

markDrop()

Marks object to drop on save.


    public
                    markDrop() : static

Return values

static

needToSendPublicPull()


    public
                    needToSendPublicPull() : bool

Return values

bool

onAfterOrmUpdate()


    public
                    onAfterOrmUpdate(array<string|int, mixed> $fields) : self

Parameters

$fields : array<string|int, mixed>

Return values

self

prepareAliasToLoad()


    public
                    prepareAliasToLoad(mixed $alias) : string|null

Parameters

$alias : mixed

Return values

string|null

prepareFields()


    public
                    prepareFields() : Result

Return values

Result

read()


    public
                    read([bool $onlyRecent = false ][, bool $byEvent = false ]) : Result

Parameters

$onlyRecent : bool = false
$byEvent : bool = false

Return values

Result

readAllChats()


    public
            static        readAllChats(int $userId) : Result

Parameters

$userId : int

Return values

Result

readAllMessages()


    public
                    readAllMessages([bool $byEvent = false ]) : Result

Parameters

$byEvent : bool = false

Return values

Result

readMessages()


    public
                    readMessages(MessageCollection|null $messages[, bool $byEvent = false ]) : Result

Parameters

$messages : MessageCollection|null
$byEvent : bool = false

Return values

Result

readTo()


    public
                    readTo(Message $message[, bool $byEvent = false ]) : Result

Parameters

$message : Message
$byEvent : bool = false

Return values

Result

save()

Saves object state into database.


    public
                    save() : Result

Return values

Result

sendMessage()


    public
                    sendMessage(Message $message[, SendingConfig|null $sendingConfig = null ]) : SendResult

Parameters

$message : Message
$sendingConfig : SendingConfig|null = null

Return values

SendResult

sendMessageUpdateAvatar()


    public
                    sendMessageUpdateAvatar([bool $skipRecent = false ]) : void

Parameters

$skipRecent : bool = false

sendPushUpdateMessage()


    public
                    sendPushUpdateMessage(Message $message) : void

Parameters

$message : Message

setAliasName()


    public
                    setAliasName(string $aliasName) : self

Parameters

$aliasName : string

Return values

self

setAuthorId()


    public
                    setAuthorId(int $authorId) : self

Parameters

$authorId : int

Return values

self

setAvatarId()


    public
                    setAvatarId(int|null $avatarId) : self

Parameters

$avatarId : int|null

Return values

self

setCallNumber()


    public
                    setCallNumber(string|null $callNumber) : self

Parameters

$callNumber : string|null

Return values

self

setCallType()


    public
                    setCallType(int|null $callType) : self

Parameters

$callType : int|null

Return values

self

setCanPost()


    public
                    setCanPost(string $canPost) : $this

Parameters

$canPost : string

Return values

$this

setChatParams()


    public
                    setChatParams([array<string|int, mixed> $chatParams = [] ]) : self

Parameters

$chatParams : array<string|int, mixed> = []

Return values

self

setColor()


    public
                    setColor(string|null $color) : self

Parameters

$color : string|null

Return values

self

setContext()


    public
                    setContext(Context|null $context) : self

Parameters

$context : Context|null

Return values

self

setContextUser()


    public
                    setContextUser(mixed $user) : self

Parameters

$user : mixed

Return values

self

setDateCreate()


    public
                    setDateCreate(DateTime|null $dateCreate) : self

Parameters

$dateCreate : DateTime|null

Return values

self

setDescription()


    public
                    setDescription(string|null $description) : self

Parameters

$description : string|null

Return values

self

setDialogId()


    public
                    setDialogId(string $dialogId) : self

Parameters

$dialogId : string

Return values

self

setDisappearingTime()


    public
                    setDisappearingTime(int $disappearingTime) : self

Parameters

$disappearingTime : int

Return values

self

setDiskFolderId()


    public
                    setDiskFolderId(int|null $diskFolderId) : self

Parameters

$diskFolderId : int|null

Return values

self

setEntityData1()


    public
                    setEntityData1(string|null $entityData1) : self

Parameters

$entityData1 : string|null

Return values

self

setEntityData2()


    public
                    setEntityData2(string|null $entityData2) : self

Parameters

$entityData2 : string|null

Return values

self

setEntityData3()


    public
                    setEntityData3(string|null $entityData3) : self

Parameters

$entityData3 : string|null

Return values

self

setEntityId()


    public
                    setEntityId(string|null $entityId) : self

Parameters

$entityId : string|null

Return values

self

setEntityType()


    public
                    setEntityType(string|null $entityType) : self

Parameters

$entityType : string|null

Return values

self

setExtranet()


    public
                    setExtranet(bool|null $extranet) : self

Parameters

$extranet : bool|null

Return values

self

setLastMessageId()


    public
                    setLastMessageId(int $lastMessageId) : self

Parameters

$lastMessageId : int

Return values

self

setLastMessageStatus()


    public
                    setLastMessageStatus(string|null $lastMessageStatus) : self

Parameters

$lastMessageStatus : string|null

Return values

self

setManageMessages()


    public
                    setManageMessages(string $manageMessages) : self

Parameters

$manageMessages : string: ALL|OWNER|MANAGER

Return values

self

setManagers()


    public
                    setManagers(array<string|int, mixed> $managerIds) : self

Parameters

$managerIds : array<string|int, mixed>

Return values

self

setManageSettings()


    public
                    setManageSettings(string $manageSettings) : self

Parameters

$manageSettings : string: OWNER|MANAGERS

Return values

self

setManageUI()


    public
                    setManageUI(string $manageUI) : self

Parameters

$manageUI : string: ALL|OWNER|MANAGERS

Return values

self

setManageUsersAdd()


    public
                    setManageUsersAdd(string $manageUsersAdd) : self

Parameters

$manageUsersAdd : string: MEMBER|OWNER|MANAGERS

Return values

self

setManageUsersDelete()


    public
                    setManageUsersDelete(string $manageUsersDelete) : self

Parameters

$manageUsersDelete : string: MEMBER|OWNER|MANAGERS

Return values

self

setMessageCount()


    public
                    setMessageCount(int $messageCount) : self

Parameters

$messageCount : int

Return values

self

setParentChat()


    public
                    setParentChat(Chat|null $chat) : self

Parameters

$chat : Chat|null

Return values

self

setParentChatId()


    public
                    setParentChatId(int $parentChatId) : self

Parameters

$parentChatId : int

Return values

self

setParentMessage()


    public
                    setParentMessage(Message|null $message) : self

Parameters

$message : Message|null

Return values

self

setParentMessageId()


    public
                    setParentMessageId(int $messageId) : self

Parameters

$messageId : int

Return values

self

setPinMessageId()


    public
                    setPinMessageId(int|null $pinMessageId) : self

Parameters

$pinMessageId : int|null

Return values

self

setPrevMessageId()


    public
                    setPrevMessageId(int $prevMessageId) : self

Parameters

$prevMessageId : int

Return values

self

setPrimaryId()


    public
                    setPrimaryId(int $primaryId) : self

Parameters

$primaryId : int

Return values

self

setRegistry()


    public
                    setRegistry(Registry $registry) : self

Parameters

$registry : Registry

Return values

self

setRelations()


    public
                    setRelations(RelationCollection $relations) : self

Parameters

$relations : RelationCollection

Return values

self

setTitle()


    public
                    setTitle(string|null $title) : self

Parameters

$title : string|null

Return values

self

setType()


    public
                    setType(string $type) : self

Parameters

$type : string

Return values

self

setUserCount()


    public
                    setUserCount(int $userCount) : self

Parameters

$userCount : int

Return values

self

startRecordVoice()


    public
                    startRecordVoice() : void

subscribe()


    public
                    subscribe([bool $subscribe = true ][, int|null $userId = null ]) : Result

Parameters

$subscribe : bool = true
$userId : int|null = null

Return values

Result

subscribeUsers()


    public
                    subscribeUsers([bool $subscribe = true ][, array<string|int, mixed> $userIds = [] ][, int|null $lastId = null ]) : Result

Parameters

$subscribe : bool = true
$userIds : array<string|int, mixed> = []
$lastId : int|null = null

Return values

Result

toArray()

Returns object state as array.


    public
                    toArray() : array<string|int, mixed>

Return values

array<string|int, mixed>

toPullFormat()


    public
                    toPullFormat() : array<string|int, mixed>

Return values

array<string|int, mixed>

toRestFormat()

Returns an array in JSON like format to return the entity as a rest response.


    public
                    toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null

Parameters

$option : array<string|int, mixed> = []

Return values

array<string|int, mixed>|null

unlinkStructureNodes()


    public
                    unlinkStructureNodes(array<string|int, mixed> $structureNodes) : void

Parameters

$structureNodes : array<string|int, mixed>

updateMessage()


    public
                    updateMessage(Message $message) : Result

Parameters

$message : Message

Return values

Result

updateStateAfterOrmEvent()


    public
            static        updateStateAfterOrmEvent(int $id, array<string|int, mixed> $fields) : void

Parameters

$id : int
$fields : array<string|int, mixed>

validateColor()


    public
                    validateColor() : Result

Return values

Result

withContext()

Provides local context for the action.


    public
                    withContext(Context|null $context) : static

Parameters

$context : Context|null

Return values

static

withContextUser()

Provides local context for the action.


    public
                    withContextUser(int|User|User $user) : static

Parameters

$user : int|User|User

Return values

static

CommentChat extends GroupChat

Table of Contents

Constants

Methods

Constants

AVAILABLE_PARAMS

ENTITY_TYPE_FAVORITE

ENTITY_TYPE_GENERAL

ENTITY_TYPE_GENERAL_CHANNEL

ENTITY_TYPE_LINE

ENTITY_TYPE_LIVECHAT

ENTITY_TYPE_VIDEOCONF

IM_TYPE_CHANNEL

IM_TYPE_CHAT

IM_TYPE_COLLAB

IM_TYPE_COMMENT

IM_TYPE_COPILOT

IM_TYPE_OPEN

IM_TYPE_OPEN_CHANNEL

IM_TYPE_OPEN_LINE

IM_TYPE_PRIVATE

IM_TYPE_SYSTEM

IM_TYPES

IM_TYPES_TRANSLATE

MANAGE_RIGHTS_MANAGERS

MANAGE_RIGHTS_MEMBER

MANAGE_RIGHTS_NONE

MANAGE_RIGHTS_OWNER

ROLE_GUEST

ROLE_MANAGER

ROLE_MEMBER

ROLE_NONE

ROLE_OWNER

Methods

__construct()

Parameters

add()

Parameters

Return values

addManagers()

Parameters

Return values

addUsers()

Parameters

Return values

allowMention()

Return values

canDo()

Parameters

Return values

changeAuthor()

changeManagersByMap()

Parameters

Return values

checkAccess()

Parameters

Return values

checkAllowedAction()

Parameters

Return values

checkColor()

Return values

checkTitle()

Return values

cleanAccessCache()

Parameters

cleanCache()

Parameters

create()

Parameters

Return values

createChatIfNotExists()

Parameters

Return values

delete()

Return values

deleteChat()

Tags

Return values

deleteManagers()