Bitrix API

NotViewed extends LogMessage uses ModelDataTrait, SentContactContentBlockTrait, MessageTrait

Table of Contents

Methods

__construct()  : mixed
canUseColorSelector()  : bool
getAdditionalIconButton()  : IconButton|null
Additional icon-like button in footer
getAuthorId()  : int|null
Get item created by identifier
getBackgroundColorToken()  : string
Get code of icon background color
getButtons()  : array<string|int, Button>|null
Get footer buttons
getChangeStreamButton()  : ChangeStreamButton|null
Change stream button used to change item stream: Scheduled -> History or History <--> Fixed history
getColor()  : array<string|int, mixed>|null
getCommonContentBlocksBlocks()  : array<string|int, mixed>
getContactId()  : int|null
getContactTypeId()  : int|null
getContentBlocks()  : array<string|int, ContentBlock>|null
Get item content blocks
getContext()  : Context
getCounterType()  : string|null
If necessary to show counter near icon, method will return type of the counter
getDate()  : DateTime|null
Get item header date.
getDatePlaceholder()  : string|null
Placeholder for cases when date is empty
getIcon()  : Icon|null
Icon of timeline record
getIconBackgroundColor()  : string|null
getIconCode()  : string|null
Code of item icon
getInfoHelper()  : InfoHelper|null
Hint icon in item header
getLayout()  : Layout
getLinkHash()  : string|null
getLinkRule()  : array<string|int, mixed>
getLogo()  : Logo|null
Get item logotype
getMarketPanel()  : MarketPanel|null
getMenuItems()  : array<string|int, MenuItem>|null
Get footer context menu items
getModel()  : Model
Get model with data from timeline database table
getNoteItemId()  : int
getNoteItemType()  : int
getPayload()  : Payload|null
getSentContactContentBlock()  : ContentBlock
getSort()  : array<string|int, mixed>
getTags()  : array<string|int, Tag>|null
Get header tags
getTimestamp()  : int|null
getTitle()  : string|null
Get item title
getTitleAction()  : Action|null
Get item title onClick action
getType()  : string
String type identifier of item
hasContact()  : bool
isActive()  : bool
Checks item status.
isLogMessage()  : bool
Is item a log message.
isScheduled()  : bool
jsonSerialize()  : array<string|int, mixed>
needShowNotes()  : bool
Can notes block be shown
needShowRestAppLayoutBlocks()  : bool

Methods

canUseColorSelector()

public canUseColorSelector() : bool
Return values
bool

getAuthorId()

Get item created by identifier

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

getBackgroundColorToken()

Get code of icon background color

public getBackgroundColorToken() : string
Return values
string

getButtons()

Get footer buttons

public getButtons() : array<string|int, Button>|null
Return values
array<string|int, Button>|null

getColor()

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

getCommonContentBlocksBlocks()

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

getContactId()

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

getContactTypeId()

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

getCounterType()

If necessary to show counter near icon, method will return type of the counter

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

getDatePlaceholder()

Placeholder for cases when date is empty

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

getIconBackgroundColor()

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

getIconCode()

Code of item icon

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

getLinkHash()

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

getLinkRule()

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

getMenuItems()

Get footer context menu items

public getMenuItems() : array<string|int, MenuItem>|null
Return values
array<string|int, MenuItem>|null

getNoteItemId()

public getNoteItemId() : int
Return values
int

getNoteItemType()

public getNoteItemType() : int
Return values
int

getSentContactContentBlock()

public getSentContactContentBlock(int|null $contactTypeId, int|null $contactId, int|null $timestamp) : ContentBlock
Parameters
$contactTypeId : int|null
$contactId : int|null
$timestamp : int|null
Return values
ContentBlock

getSort()

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

getTags()

Get header tags

public getTags() : array<string|int, Tag>|null
Return values
array<string|int, Tag>|null

getTimestamp()

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

getTitle()

Get item title

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

getType()

String type identifier of item

public getType() : string
Return values
string

isActive()

Checks item status.

public static isActive() : bool
Return values
bool

isLogMessage()

Is item a log message.

public isLogMessage() : bool

Log messages have their own representation

Return values
bool

isScheduled()

public isScheduled() : bool
Return values
bool

jsonSerialize()

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

needShowNotes()

Can notes block be shown

public needShowNotes() : bool
Return values
bool

needShowRestAppLayoutBlocks()

public needShowRestAppLayoutBlocks() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results