Bitrix API

Message implements ArrayAccess, RegistryEntry, ActiveRecord, RestEntity, PopupDataAggregatable, DateFilterable uses FieldAccessImplementation, ActiveRecordImplementation, RegistryEntryImplementation, ContextCustomer

Chat version #2

Table of Contents

Interfaces

ArrayAccess
RegistryEntry
ActiveRecord
RestEntity
PopupDataAggregatable
An interface for classes that have entities within them that should be taken to the top level of a REST response.
DateFilterable

Constants

MESSAGE_MAX_LENGTH  = 20000
REST_FIELDS  = ['ID', 'CHAT_ID', 'AUTHOR_ID', 'DATE_CREATE', 'MESSAGE', 'NOTIFY_EVENT', 'NOTIFY_READ']

Methods

__construct()  : mixed
addFile()  : self
addToReminder()  : Result
allowNotifyAnswer()  : bool|null
autocompleteParams()  : self
checkAccess()  : Result
checkEmoji()  : self
Parse dates from message.
delete()  : Result
deleteComplete()  : Result
deleteHard()  : Result
deleteSoft()  : Result
fill()  : static
Fills object's fields with provided values.
fillActual()  : self
fillFiles()  : self
fillMessageOut()  : string|null
filterByDate()  : FilterResult<string|int, static|null>
filterMessageText()  : void
generateUrlPreview()  : void
Appends message with an url preview attachment.
getAdditionalMessageIds()  : array<string|int, mixed>
getAttach()  : AttachArray|MessageParameter
getAuthor()  : User|null
getAuthorId()  : int
getChat()  : Chat
getChatId()  : int|null
getContext()  : Context
Returns the local or global context for the action.
getContextId()  : string
getCopilotData()  : array<string|int, mixed>|null
getDataClass()  : string
Returns ORM tablet class name.
getDataEntity()  : EntityObject
getDateCreate()  : DateTime|null
getDefaultDateCreate()  : DateTime
getDefaultNotifyEvent()  : string|null
getDefaultNotifyModule()  : string|null
getDefaultNotifyRead()  : bool
getDefaultNotifyType()  : int
getDisappearingTime()  : DateTime|null
getEmailTemplate()  : string|null
getEnrichedParams()  : Params
getFileIds()  : array<string|int, int>
getFiles()  : FileCollection
getFilesDiskData()  : array<string|int, mixed>
getFileUuid()  : string|null
getFormattedMessage()  : string
getForPush()  : string
getForwardInfo()  : array<string|int, mixed>|null
getForwardUuid()  : string|null
getId()  : int|null
Returns the id of the entity
getImportantFor()  : array<string|int, mixed>
getImportId()  : int|null
getKeyboard()  : Keyboard|MessageParameter
getMenu()  : Menu|MessageParameter
getMessage()  : string|null
getMessageId()  : int|null
getMessageOut()  : string|null
getNotifyButtons()  : array<string|int, mixed>|null
getNotifyEvent()  : string|null
Returns source module event id.
getNotifyLink()  : string|null
getNotifyModule()  : string|null
getNotifySubTag()  : string|null
getNotifyTag()  : string|null
getNotifyTitle()  : string|null
getNotifyType()  : int
getParams()  : Params
getParsedMessage()  : string
getPopupData()  : PopupData
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
getPrevId()  : int
getPreviewMessage()  : string
getPrimaryId()  : int|null
getPushAppId()  : string|null
getPushMessage()  : string|null
getPushParams()  : array<string|int, mixed>|null
getQuotedMessage()  : string
getReactions()  : ReactionMessage
getRegistry()  : Registry|null
Return link of the object's registry.
getRelatedChatId()  : int|null
getReminder()  : ReminderItem|null
getReplaceMap()  : array<string|int, mixed>
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
getUrl()  : UrlItem|null
getUserIds()  : array<string|int, mixed>
getUserIdsFromMention()  : array<string|int, mixed>
getUserIdsToSendMentions()  : array<string|int, mixed>
getUuid()  : string|null
hasFiles()  : bool
isChanged()  : bool
Tells true if object has been changed.
isCompletelyEmpty()  : bool
isDeleted()  : bool
Tells true if object marked to drop.
isDisappearing()  : bool
isForward()  : bool
isImportant()  : bool|null
isNotifyFlash()  : bool|null
isNotifyRead()  : bool|null
isSystem()  : bool
isUnread()  : bool
isViewed()  : bool
isViewedByOthers()  : bool
load()  : Result
loadPhrases()  : void
Lazy load message's context phrases.
mark()  : Result
markAsFavorite()  : Result
markAsImportant()  : self
markAsSystem()  : self
markChanged()  : static
Marks object changed.
markDrop()  : static
Marks object to drop on save.
markNotifyAnswer()  : self
markNotifyFlash()  : self
markNotifyRead()  : self
offsetExists()  : bool
offsetGet()  : mixed
offsetSet()  : void
offsetUnset()  : void
onAfterOrmUpdate()  : self
parseDates()  : self
Parse dates from message.
pin()  : Result
prepareFields()  : Result
processChangeAuthorId()  : int
processChangeNotifyEvent()  : string|null
resetParams()  : $this
save()  : Result
Saves object state into database.
setAttach()  : $this
setAuthorId()  : self
setBotId()  : self
setChat()  : self
setChatId()  : self
setContext()  : self
Sets new context for operations.
setContextUser()  : self
setDateCreate()  : static
setEmailTemplate()  : self
setFiles()  : static
setFileUuid()  : self
setForwardUuid()  : self
setImportantFor()  : self
setImportId()  : self
setKeyboard()  : $this
setMenu()  : self
setMessage()  : self
setMessageId()  : self
setMessageOut()  : self
setNotifyButtons()  : self
setNotifyEvent()  : string|null
Sets source module event id.
setNotifyLink()  : self
setNotifyModule()  : self
setNotifySubTag()  : self
setNotifyTag()  : self
setNotifyTitle()  : self
setNotifyType()  : self
setParams()  : $this
setPrimaryId()  : self
setPushAppId()  : self
setPushMessage()  : self
setPushParams()  : self
setReactions()  : $this
setRegistry()  : self
setUnread()  : self
setUrl()  : self
setUuid()  : self
setViewed()  : self
toArray()  : array<string|int, mixed>
Returns object state as array.
toRestFormat()  : array<string|int, mixed>
Returns an array in JSON like format to return the entity as a rest response.
unmarkAsFavorite()  : Result
unpin()  : Result
updateSearchIndex()  : void
Update search index record.
uploadFileFromText()  : array<string|int, mixed>
Extracts and saves files from message text.
withContext()  : static
Provides local context for the action.
withContextUser()  : static
Provides local context for the action.

Constants

MESSAGE_MAX_LENGTH

public mixed MESSAGE_MAX_LENGTH = 20000

REST_FIELDS

public mixed REST_FIELDS = ['ID', 'CHAT_ID', 'AUTHOR_ID', 'DATE_CREATE', 'MESSAGE', 'NOTIFY_EVENT', 'NOTIFY_READ']

Methods

__construct()

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

allowNotifyAnswer()

public allowNotifyAnswer() : bool|null
Return values
bool|null

checkAccess()

public checkAccess([int|null $userId = null ]) : Result
Parameters
$userId : int|null = null
Return values
Result

checkEmoji()

Parse dates from message.

public checkEmoji() : self
Return values
self

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

fillMessageOut()

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

filterMessageText()

public filterMessageText() : void

generateUrlPreview()

Appends message with an url preview attachment.

public generateUrlPreview() : void

getAdditionalMessageIds()

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

getAuthorId()

public getAuthorId() : int
Return values
int

getChatId()

public getChatId() : int|null
Return values
int|null

getContextId()

public getContextId() : string
Return values
string

getCopilotData()

public getCopilotData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getDataClass()

Returns ORM tablet class name.

public static getDataClass() : string
Tags
@return

string|DataManager;

Return values
string

getDefaultNotifyEvent()

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

getDefaultNotifyModule()

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

getDefaultNotifyRead()

public getDefaultNotifyRead() : bool
Return values
bool

getDefaultNotifyType()

public getDefaultNotifyType() : int
Return values
int

getEmailTemplate()

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

getEnrichedParams()

public getEnrichedParams([bool $withUrl = true ]) : Params
Parameters
$withUrl : bool = true
Return values
Params

getFileIds()

public getFileIds() : array<string|int, int>
Return values
array<string|int, int>

getFilesDiskData()

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

getFileUuid()

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

getFormattedMessage()

public getFormattedMessage() : string
Return values
string

getForPush()

public getForPush([int|null $messageSize = 200 ]) : string
Parameters
$messageSize : int|null = 200
Return values
string

getForwardInfo()

public getForwardInfo() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getForwardUuid()

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

getId()

Returns the id of the entity

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

getImportantFor()

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

getImportId()

public getImportId() : int|null
Return values
int|null

getMessage()

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

getMessageId()

public getMessageId() : int|null
Return values
int|null

getMessageOut()

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

getNotifyButtons()

public getNotifyButtons() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getNotifyEvent()

Returns source module event id.

public getNotifyEvent() : string|null
Tags
see
Notify
Return values
string|null
public getNotifyLink() : string|null
Return values
string|null

getNotifyModule()

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

getNotifySubTag()

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

getNotifyTag()

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

getNotifyTitle()

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

getNotifyType()

public getNotifyType() : int
Return values
int

getParams()

public getParams([bool $disallowLazyLoad = false ]) : Params
Parameters
$disallowLazyLoad : bool = false
Return values
Params

getParsedMessage()

public getParsedMessage() : string
Return values
string

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

getPrevId()

public getPrevId() : int
Return values
int

getPreviewMessage()

public getPreviewMessage([int|null $messageSize = 200 ]) : string
Parameters
$messageSize : int|null = 200
Return values
string

getPrimaryId()

public getPrimaryId() : int|null
Return values
int|null

getPushAppId()

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

getPushMessage()

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

getPushParams()

public getPushParams() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getQuotedMessage()

public getQuotedMessage([int|null $messageSize = null ]) : string
Parameters
$messageSize : int|null = null
Return values
string

getRelatedChatId()

public getRelatedChatId() : int|null
Return values
int|null

getReplaceMap()

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

getRestEntityName()

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

public static getRestEntityName() : string
Return values
string

getUserIds()

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

getUserIdsFromMention()

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

getUserIdsToSendMentions()

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

getUuid()

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

hasFiles()

public hasFiles() : bool
Return values
bool

isCompletelyEmpty()

public isCompletelyEmpty() : bool
Return values
bool

isDisappearing()

public isDisappearing() : bool
Return values
bool

isForward()

public isForward() : bool
Return values
bool

isImportant()

public isImportant() : bool|null
Return values
bool|null

isNotifyFlash()

public isNotifyFlash() : bool|null
Return values
bool|null

isNotifyRead()

public isNotifyRead() : bool|null
Return values
bool|null

isSystem()

public isSystem() : bool
Return values
bool

isUnread()

public isUnread() : bool
Return values
bool

isViewed()

public isViewed() : bool
Return values
bool

isViewedByOthers()

public isViewedByOthers() : bool
Return values
bool

loadPhrases()

Lazy load message's context phrases.

public static loadPhrases() : void

markAsImportant()

public markAsImportant([bool|null $isImportant = true ]) : self
Parameters
$isImportant : bool|null = true
Return values
self

markAsSystem()

public markAsSystem(bool $flag) : self
Parameters
$flag : bool
Return values
self

markChanged()

Marks object changed.

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

markNotifyAnswer()

public markNotifyAnswer(bool|null $value) : self
Parameters
$value : bool|null
Return values
self

markNotifyFlash()

public markNotifyFlash(bool|null $value) : self
Parameters
$value : bool|null
Return values
self

markNotifyRead()

public markNotifyRead(bool|null $value) : self
Parameters
$value : bool|null
Return values
self

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

onAfterOrmUpdate()

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

parseDates()

Parse dates from message.

public parseDates() : self
Return values
self

processChangeAuthorId()

public processChangeAuthorId(int $authorId) : int
Parameters
$authorId : int
Return values
int

processChangeNotifyEvent()

public processChangeNotifyEvent(string|null $notifyEvent) : string|null
Parameters
$notifyEvent : string|null
Return values
string|null

resetParams()

public resetParams(array<string|int, mixed> $params) : $this
Parameters
$params : array<string|int, mixed>
Return values
$this

setAttach()

public setAttach(array<string|int, mixed>|Param $attach) : $this
Parameters
$attach : array<string|int, mixed>|Param
Return values
$this

setAuthorId()

public setAuthorId(int $authorId) : self
Parameters
$authorId : int
Return values
self

setBotId()

public setBotId(int $botId) : self
Parameters
$botId : int
Return values
self

setChat()

public setChat(Chat $chat) : self
Parameters
$chat : Chat
Return values
self

setChatId()

public setChatId(int $value) : self
Parameters
$value : int
Return values
self

setContext()

Sets new context for operations.

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|string|null $value) : static
Parameters
$value : DateTime|string|null
Return values
static

setEmailTemplate()

public setEmailTemplate(string|null $value) : self
Parameters
$value : string|null
Return values
self

setFileUuid()

public setFileUuid(string|null $uuid) : self
Parameters
$uuid : string|null
Return values
self

setForwardUuid()

public setForwardUuid(string|null $forwardUuid) : self
Parameters
$forwardUuid : string|null
Return values
self

setImportantFor()

public setImportantFor(array<string|int, mixed> $importantFor) : self
Parameters
$importantFor : array<string|int, mixed>
Return values
self

setImportId()

public setImportId(int|null $value) : self
Parameters
$value : int|null
Return values
self

setKeyboard()

public setKeyboard(array<string|int, mixed>|Param|Keyboard $keyboard) : $this
Parameters
$keyboard : array<string|int, mixed>|Param|Keyboard
Return values
$this

setMenu()

public setMenu(mixed $menu) : self
Parameters
$menu : mixed
Return values
self

setMessage()

public setMessage(string|null $value) : self
Parameters
$value : string|null
Return values
self

setMessageId()

public setMessageId(int $messageId) : self
Parameters
$messageId : int
Return values
self

setMessageOut()

public setMessageOut(string|null $value) : self
Parameters
$value : string|null
Return values
self

setNotifyButtons()

public setNotifyButtons(mixed $value) : self
Parameters
$value : mixed
Return values
self

setNotifyEvent()

Sets source module event id.

public setNotifyEvent(string|null $notifyEvent) : string|null
Parameters
$notifyEvent : string|null
Tags
see
Notify
Return values
string|null
public setNotifyLink(string|null $value) : self
Parameters
$value : string|null
Return values
self

setNotifyModule()

public setNotifyModule(string|null $value) : self
Parameters
$value : string|null
Return values
self

setNotifySubTag()

public setNotifySubTag(string|null $value) : self
Parameters
$value : string|null
Return values
self

setNotifyTag()

public setNotifyTag(string|null $value) : self
Parameters
$value : string|null
Return values
self

setNotifyTitle()

public setNotifyTitle(string|null $value) : self
Parameters
$value : string|null
Return values
self

setNotifyType()

public setNotifyType(int|null $value) : self
Parameters
$value : int|null
Return values
self

setParams()

public setParams(array<string|int, mixed> $params) : $this
Parameters
$params : array<string|int, mixed>
Return values
$this

setPrimaryId()

public setPrimaryId(int $primaryId) : self
Parameters
$primaryId : int
Return values
self

setPushAppId()

public setPushAppId(string|null $message) : self
Parameters
$message : string|null
Tags
todo

Move it into special push message class.

Return values
self

setPushMessage()

public setPushMessage(string|null $message) : self
Parameters
$message : string|null
Tags
todo

Move it into special push message class.

Return values
self

setPushParams()

public setPushParams(array<string|int, mixed>|null $params) : self
Parameters
$params : array<string|int, mixed>|null
Tags
todo

Move it into special push message class.

Return values
self

setUnread()

public setUnread(bool $isUnread) : self
Parameters
$isUnread : bool
Return values
self

setUuid()

public setUuid(string|null $uuid) : self
Parameters
$uuid : string|null
Return values
self

setViewed()

public setViewed(bool $isViewed) : self
Parameters
$isViewed : bool
Return values
self

toArray()

Returns object state as array.

public toArray() : 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>
Parameters
$option : array<string|int, mixed> = []
Return values
array<string|int, mixed>

updateSearchIndex()

Update search index record.

public updateSearchIndex() : void

uploadFileFromText()

Extracts and saves files from message text.

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

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

        
On this page

Search results