Bitrix API

Chat extends BaseTable

Table of Contents

Properties

$internalClass  : string
Internal class.

Methods

add()  : AddResult
Creates new record and return it.
callback()  : void
Register calllback for internal table.
delete()  : Result
Delete record.
getList()  : Result
Returns records of table.
getMap()  : array<string|int, mixed>
Get Map of table.
getMembersId()  : array<string|int, mixed>
Returns chat members ids.
getRow()  : array<string|int, mixed>
Return chat row by id.
joinChat()  : int
Invite current user to the chat and returns IM chat id.
update()  : Result
Updates record.

Properties

$internalClass

Internal class.

public static string $internalClass = 'ChatTable'

Methods

add()

Creates new record and return it.

public static add(array<string|int, mixed> $fields) : AddResult
Parameters
$fields : array<string|int, mixed>

Fields array.

Return values
AddResult

callback()

Register calllback for internal table.

public static callback(string $code, callable $callback) : void
Parameters
$code : string

Type of callback.

$callback : callable

Callback.

delete()

Delete record.

public static delete(int $id) : Result
Parameters
$id : int

Record key.

Return values
Result

getList()

Returns records of table.

public static getList([array<string|int, mixed> $params = [] ]) : Result
Parameters
$params : array<string|int, mixed> = []

Params array like ORM style.

Return values
Result

getMap()

Get Map of table.

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

getMembersId()

Returns chat members ids.

public static getMembersId(int $chatId) : array<string|int, mixed>
Parameters
$chatId : int

Chat id.

Return values
array<string|int, mixed>

getRow()

Return chat row by id.

public static getRow(int $id) : array<string|int, mixed>
Parameters
$id : int

Chat id.

Return values
array<string|int, mixed>

joinChat()

Invite current user to the chat and returns IM chat id.

public static joinChat(int $internalId) : int
Parameters
$internalId : int

Internal chat id.

Return values
int

update()

Updates record.

public static update(int $id[, array<string|int, mixed> $fields = [] ]) : Result
Parameters
$id : int

Record key.

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

Fields array.

Return values
Result

        
On this page

Search results