Bitrix API

Zoom

Table of Contents

Methods

__construct()  : mixed
Zoom constructor.
getAccessToken()  : bool|mixed
Gets zoom access token.
getImChatConferenceUrl()  : string|null
Gets URL to join Zoom conference by making request to Zoom, or getting it from DB (if it is not expired).
getRichMessageFields()  : array<string|int, mixed>
Gets array of a message fields for IM to post a rich message with conference URL.
isActive()  : bool
Checks if zoom is active social service.
isAvailable()  : bool
Checks if Zoom integration is available for this portal.
isConnected()  : bool
Checks if zoom is connected to user profile.
requestConferenceById()  : array<string|int, mixed>|null
Gets Zoom conference information.

Methods

__construct()

Zoom constructor.

public __construct(int $userId, string $chatId) : mixed
Parameters
$userId : int
$chatId : string
Tags
throws
LoaderException

getAccessToken()

Gets zoom access token.

public getAccessToken() : bool|mixed
Tags
throws
LoaderException
Return values
bool|mixed

getImChatConferenceUrl()

Gets URL to join Zoom conference by making request to Zoom, or getting it from DB (if it is not expired).

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

getRichMessageFields()

Gets array of a message fields for IM to post a rich message with conference URL.

public getRichMessageFields(string $dialogId, string $link, int $userId) : array<string|int, mixed>
Parameters
$dialogId : string

Chat id.

$link : string

URL to Zoom conference.

$userId : int

User Id who sends the message (private chat).

Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

isActive()

Checks if zoom is active social service.

public static isActive() : bool
Tags
throws
LoaderException
Return values
bool

isAvailable()

Checks if Zoom integration is available for this portal.

public static isAvailable() : bool
Tags
throws
LoaderException
Return values
bool

isConnected()

Checks if zoom is connected to user profile.

public static isConnected(mixed $userId) : bool
Parameters
$userId : mixed
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

requestConferenceById()

Gets Zoom conference information.

public requestConferenceById(int $confId) : array<string|int, mixed>|null
Parameters
$confId : int

External conference id.

Return values
array<string|int, mixed>|null

        
On this page

Search results