Bitrix API

MessageTable extends DataManager

Class MessageTable

Fields:

  • ID int mandatory
  • CHAT_ID int mandatory
  • AUTHOR_ID int mandatory
  • MESSAGE string optional
  • MESSAGE_OUT string optional
  • DATE_CREATE datetime mandatory
  • EMAIL_TEMPLATE string(255) optional
  • NOTIFY_TYPE int optional
  • NOTIFY_MODULE string(255) optional
  • NOTIFY_EVENT string(255) optional
  • NOTIFY_TAG string(255) optional
  • NOTIFY_SUB_TAG string(255) optional
  • NOTIFY_TITLE string(255) optional
  • NOTIFY_BUTTONS string optional
  • NOTIFY_READ bool optional default 'N'
  • IMPORT_ID int optional

Table of Contents

Methods

createCollection()  : EO_Message_Collection
createObject()  : EO_Message
deleteBatch()  : void
Deletes rows by filter.
getById()  : EO_Message_Result
getByPrimary()  : EO_Message_Result
getCurrentDate()  : DateTime
Return current date for DATE_CREATE field.
getEntity()  : EO_Message_Entity
getList()  : EO_Message_Result
getMap()  : array<string|int, mixed>
Returns entity map definition.
getTableName()  : string
Returns DB table name for entity.
indexRecord()  : bool|void
Add message data to MessageIndex table
query()  : EO_Message_Query
validateEmailTemplate()  : array<string|int, mixed>
Returns validators for EMAIL_TEMPLATE field.
validateNotifyEvent()  : array<string|int, mixed>
Returns validators for NOTIFY_EVENT field.
validateNotifyModule()  : array<string|int, mixed>
Returns validators for NOTIFY_MODULE field.
validateNotifySubTag()  : array<string|int, mixed>
Returns validators for NOTIFY_SUB_TAG field.
validateNotifyTag()  : array<string|int, mixed>
Returns validators for NOTIFY_TAG field.
validateNotifyTitle()  : array<string|int, mixed>
Returns validators for NOTIFY_TITLE field.
wakeUpCollection()  : EO_Message_Collection
wakeUpObject()  : EO_Message
withNonSystemOnly()  : void
withReadOnly()  : void
withUnreadOnly()  : void
withViewedOnly()  : void

Methods

createCollection()

public static createCollection() : EO_Message_Collection
Return values
EO_Message_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_Message
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_Message

deleteBatch()

Deletes rows by filter.

public static deleteBatch(array<string|int, mixed> $filter) : void
Parameters
$filter : array<string|int, mixed>

Filter does not look like filter in getList. It depends by current implementation.

getById()

public static getById(mixed $id) : EO_Message_Result
Parameters
$id : mixed
Return values
EO_Message_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Message_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Message_Result

getCurrentDate()

Return current date for DATE_CREATE field.

public static getCurrentDate() : DateTime
Return values
DateTime

getEntity()

public static getEntity() : EO_Message_Entity
Return values
EO_Message_Entity

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Message_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_Message_Result

getMap()

Returns entity map definition.

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

getTableName()

Returns DB table name for entity.

public static getTableName() : string
Return values
string

indexRecord()

Add message data to MessageIndex table

public static indexRecord(mixed $id) : bool|void
Parameters
$id : mixed
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool|void

query()

public static query() : EO_Message_Query
Return values
EO_Message_Query

validateEmailTemplate()

Returns validators for EMAIL_TEMPLATE field.

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

validateNotifyEvent()

Returns validators for NOTIFY_EVENT field.

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

validateNotifyModule()

Returns validators for NOTIFY_MODULE field.

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

validateNotifySubTag()

Returns validators for NOTIFY_SUB_TAG field.

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

validateNotifyTag()

Returns validators for NOTIFY_TAG field.

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

validateNotifyTitle()

Returns validators for NOTIFY_TITLE field.

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

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_Message_Collection
Parameters
$rows : mixed
Return values
EO_Message_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_Message
Parameters
$row : mixed
Return values
EO_Message

withNonSystemOnly()

public static withNonSystemOnly(Query $query) : void
Parameters
$query : Query

withReadOnly()

public static withReadOnly(Query $query) : void
Parameters
$query : Query

withUnreadOnly()

public static withUnreadOnly(Query $query) : void
Parameters
$query : Query

withViewedOnly()

public static withViewedOnly(Query $query) : void
Parameters
$query : Query 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results