Bitrix API

Output

Class Base

Table of Contents

Methods

getInstance()  : self
isAvailable()  : bool
Checks if an interactive message is available for the open line.
isLoadedKeyboard()  : bool
Is data loading keyboard.
nativeMessageProcessing()  : array<string|int, mixed>
The transformation of the description of the outgoing message in native format if possible.
processSendingMessage()  : array<string|int, mixed>
Processing an outgoing message to the connector.
setAppParams()  : bool
Setting the custom imessage application params.
setFormIds()  : bool
Setting the list of id forms to send.
setInstance()  : void
setKeyboardData()  : self
Add keyboard data.
setOauthParams()  : bool
Setting the OAuth application params.
setPaymentData()  : bool
Setting payment data to be sent in a native message.
setProductIds()  : void
Sets an array of catalog products external (facebook) ID's for a message.

Methods

getInstance()

public static getInstance([int $chatId = 0 ][, array<string|int, mixed> $params = [] ]) : self
Parameters
$chatId : int = 0
$params : array<string|int, mixed> = []
Return values
self

isAvailable()

Checks if an interactive message is available for the open line.

public isAvailable(int $lineId) : bool
Parameters
$lineId : int

Open line id.

Return values
bool

isLoadedKeyboard()

Is data loading keyboard.

public isLoadedKeyboard() : bool
Return values
bool

nativeMessageProcessing()

The transformation of the description of the outgoing message in native format if possible.

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

processSendingMessage()

Processing an outgoing message to the connector.

public static processSendingMessage(array<string|int, mixed> $messageFields, string $connectorId) : array<string|int, mixed>
Parameters
$messageFields : array<string|int, mixed>
$connectorId : string
Return values
array<string|int, mixed>

setAppParams()

Setting the custom imessage application params.

public setAppParams([array<string|int, mixed> $params = [] ]) : bool
Parameters
$params : array<string|int, mixed> = []
Return values
bool

setFormIds()

Setting the list of id forms to send.

public setFormIds([array<string|int, mixed> $ids = [] ]) : bool
Parameters
$ids : array<string|int, mixed> = []
Return values
bool

setInstance()

public static setInstance(int $chatId, Output $interactiveMessage) : void
Parameters
$chatId : int
$interactiveMessage : Output

setKeyboardData()

Add keyboard data.

public setKeyboardData([array<string|int, mixed> $data = [] ]) : self
Parameters
$data : array<string|int, mixed> = []
Return values
self

setOauthParams()

Setting the OAuth application params.

public setOauthParams([array<string|int, mixed> $params = [] ]) : bool
Parameters
$params : array<string|int, mixed> = []
Return values
bool

setPaymentData()

Setting payment data to be sent in a native message.

public setPaymentData([array<string|int, mixed> $data = [] ]) : bool
Parameters
$data : array<string|int, mixed> = []
Return values
bool

setProductIds()

Sets an array of catalog products external (facebook) ID's for a message.

public setProductIds([array<string|int, mixed> $ids = [] ]) : void
Parameters
$ids : array<string|int, mixed> = []

External (facebook) ids of catalog products.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results