Bitrix API

ReadService uses ContextCustomer

Table of Contents

Methods

__construct()  : mixed
deleteByChatId()  : void
deleteByMessage()  : void
getChatMessageStatus()  : string
getContext()  : Context
Returns the local or global context for the action.
getCounterService()  : CounterService
getCountersForUsers()  : array<string|int, mixed>
Send a push about counter changes.
getLastIdByChatId()  : int
getLastMessageIdInChat()  : int
getReadStatusesByMessageIds()  : array<string|int, mixed>
getViewedService()  : ViewedService
getViewStatusesByMessageIds()  : array<string|int, mixed>
markMessageUnread()  : self
Marks message as unread and reads messages up to the sent message accept author.
markNotificationUnread()  : self
Marks notification as unread.
markRecentUnread()  : $this
Mark chat unread in Recent.
onAfterMessageSend()  : Result
Returns unread counters for the rest answer.
onAfterNotificationSend()  : Result
read()  : Result
readAll()  : void
readAllInChat()  : Result
readChildren()  : array<string|int, mixed>
readNotifications()  : Result
readTo()  : Result
setContext()  : self
setContextUser()  : self
setLastIdForRead()  : void
unreadNotifications()  : Result
unreadTo()  : Result
withContext()  : static
Provides local context for the action.
withContextUser()  : static
Provides local context for the action.

Methods

__construct()

public __construct([int|null $userId = null ]) : mixed
Parameters
$userId : int|null = null

deleteByChatId()

public deleteByChatId(int $chatId) : void
Parameters
$chatId : int

deleteByMessage()

public deleteByMessage(Message $message[, array<string|int, mixed>|null $invalidateCacheUsers = null ]) : void
Parameters
$message : Message
$invalidateCacheUsers : array<string|int, mixed>|null = null

getChatMessageStatus()

public getChatMessageStatus(int $chatId) : string
Parameters
$chatId : int
Return values
string

getLastIdByChatId()

public getLastIdByChatId(int $chatId) : int
Parameters
$chatId : int
Return values
int

getLastMessageIdInChat()

public getLastMessageIdInChat(int $chatId) : int
Parameters
$chatId : int
Return values
int

getReadStatusesByMessageIds()

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

getViewStatusesByMessageIds()

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

markRecentUnread()

Mark chat unread in Recent.

public markRecentUnread(Message $message) : $this
Parameters
$message : Message
Return values
$this

readChildren()

public readChildren(Chat $parentChat) : array<string|int, mixed>
Parameters
$parentChat : Chat
Return values
array<string|int, mixed>

setContextUser()

public setContextUser(mixed $user) : self
Parameters
$user : mixed
Return values
self

setLastIdForRead()

public setLastIdForRead(int $lastId, int $chatId) : void
Parameters
$lastId : int
$chatId : int

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