Класс Chat

Граф наследования:Chat:

Открытые статические члены
static	getTypes ()
static	getType ($chatData)
static	getRelation ($chatId, $params=[])
static	mute ($chatId, $action, $userId=null)
static	getMessageCount ($chatId, $userId=null)
static	hasAccess ($chatId)
static	getMessages ($chatId, $userId=null, $options=Array())
static	getUsers ($chatId, $options=[])
static	getById ($id, $params=array())
static	getList ($params=array())
static	formatChatData ($chat)
static	getListParams ($params)
static	toJson ($array)
static	isUserInChat ($chatId, $userId=0)
static	isUserKickedFromChat ($chatId, $userId=0)
static	checkReplicaDeprecatedAgent ()
static	isActionAllowed ($dialogId, $action, $entityType=null)
static	getOwnerById ($dialogId)
static	fillCounterData (array $chats)

Открытые атрибуты
const	TYPE_SYSTEM = 'S'
const	TYPE_PRIVATE = 'P'
const	TYPE_OPEN = 'O'
const	TYPE_THREAD = 'T'
const	TYPE_GROUP = 'C'
const	TYPE_CHANNEL = 'N'
const	TYPE_OPEN_LINE = 'L'
const	STATUS_UNREAD = 0
const	STATUS_NOTIFY = 1
const	STATUS_READ = 2
const	LIMIT_SEND_EVENT = 30
const	FILTER_LIMIT = 50

Подробное описание

См. определение в файле chat.php строка 18

Методы

checkReplicaDeprecatedAgent()

static checkReplicaDeprecatedAgent ( )

static

См. определение в файле chat.php строка 1302

fillCounterData()

static fillCounterData ( array $chats )

static

См. определение в файле chat.php строка 1406

formatChatData()

static formatChatData ( $chat )

static

См. определение в файле chat.php строка 994

getById()

static getById ( $id, $params = array() )

static

Аргументы

	$id
array	$params

Возвращает

array|bool|mixed

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\LoaderException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле chat.php строка 851

getList()

static getList ( $params = array() )

static

См. определение в файле chat.php строка 926

getListParams()

static getListParams ( $params )

static

См. определение в файле chat.php строка 1077

getMessageCount()

static getMessageCount ( $chatId, $userId = null )

static

См. определение в файле chat.php строка 414

getMessages()

static getMessages ( $chatId, $userId = null, $options = Array() )

static

Аргументы

	$chatId
null	$userId
array	$options

Возвращает

array|bool

См. определение в файле chat.php строка 462

getOwnerById()

static getOwnerById ( $dialogId )

static

Get chat authorId by dialogId

Аргументы

int | string

$dialogId

Возвращает

int|null AUTHOR_ID

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле chat.php строка 1385

getRelation()

static getRelation ( $chatId, $params = [] )

static

См. определение в файле chat.php строка 84

getType()

static getType ( $chatData )

static

См. определение в файле chat.php строка 41

getTypes()

static getTypes ( )

static

См. определение в файле chat.php строка 36

getUsers()

static getUsers ( $chatId, $options = [] )

static

См. определение в файле chat.php строка 787

hasAccess()

static hasAccess ( $chatId )

static

Переопределяется в CommentChat и NullChat.

См. определение в файле chat.php строка 445

isActionAllowed()

static isActionAllowed ( $dialogId, $action, $entityType = null )

static

Returns the value of the chat option by dialogId.

Аргументы

int | string	$dialogId
string	$action	- chat option.

См. также

\CIMChat::GetChatOptions()

Аргументы

string | null

$entityType

- if $entityType is known, you can avoid accessing the database.

Возвращает

bool

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле chat.php строка 1322

isUserInChat()

static isUserInChat ( $chatId, $userId = 0 )

static

См. определение в файле chat.php строка 1252

isUserKickedFromChat()

static isUserKickedFromChat ( $chatId, $userId = 0 )

static

См. определение в файле chat.php строка 1277

mute()

static mute ( $chatId, $action, $userId = null )

static

См. определение в файле chat.php строка 332

toJson()

static toJson ( $array )

static

См. определение в файле chat.php строка 1247

Данные класса

FILTER_LIMIT

const FILTER_LIMIT = 50

См. определение в файле chat.php строка 34

LIMIT_SEND_EVENT

const LIMIT_SEND_EVENT = 30

См. определение в файле chat.php строка 32

STATUS_NOTIFY

const STATUS_NOTIFY = 1

См. определение в файле chat.php строка 29

STATUS_READ

const STATUS_READ = 2

См. определение в файле chat.php строка 30

STATUS_UNREAD

const STATUS_UNREAD = 0

См. определение в файле chat.php строка 28

TYPE_CHANNEL

const TYPE_CHANNEL = 'N'

См. определение в файле chat.php строка 25

TYPE_GROUP

const TYPE_GROUP = 'C'

См. определение в файле chat.php строка 24

TYPE_OPEN

const TYPE_OPEN = 'O'

См. определение в файле chat.php строка 22

TYPE_OPEN_LINE

const TYPE_OPEN_LINE = 'L'

См. определение в файле chat.php строка 26

TYPE_PRIVATE

const TYPE_PRIVATE = 'P'

См. определение в файле chat.php строка 21

TYPE_SYSTEM

const TYPE_SYSTEM = 'S'

См. определение в файле chat.php строка 20

TYPE_THREAD

const TYPE_THREAD = 'T'

См. определение в файле chat.php строка 23