Bitrix API

GroupChatService

Table of Contents

Methods

__construct() : mixed
addAdminByChatId() : Result
addUsersByChatId() : Result
createChat() : Result|CreateGroupChatResult
isAvailable() : bool
setChatDescription() : Result

__construct()


    public
                    __construct() : mixed

addAdminByChatId()


    public
                    addAdminByChatId(int $chatId, int $adminId) : Result

Parameters

$chatId : int
$adminId : int

Return values

Result

addUsersByChatId()


    public
                    addUsersByChatId(int $chatId, array<string|int, mixed> $userIds) : Result

Parameters

$chatId : int
$userIds : array<string|int, mixed>

Return values

Result

createChat()


    public
                    createChat(array{USERS: int[], TITLE?: ?string, DESCRIPTION?: ?string} $chatParams) : Result|CreateGroupChatResult

Parameters

$chatParams : array{USERS: int[], TITLE?: ?string, DESCRIPTION?: ?string}

Return values

Result|CreateGroupChatResult

isAvailable()


    public
                    isAvailable() : bool

Return values

bool

setChatDescription()


    public
                    setChatDescription(int $chatId, string $description) : Result

Parameters

$chatId : int
$description : string

Return values

Result