Bitrix API

MenuBot

Common interface for chat menu.

Table of Contents

Methods

getBotMenu()  : ItrMenu|null
Returns stored data for ITR menu.
getMenuState()  : array<string|int, mixed>|null
Returns user's menu track.
hasBotMenu()  : bool
Checks if bot has ITR menu.
saveMenuState()  : void
Saves user's menu track.
sendMenuResult()  : bool
Sends result of the user interaction with ITR menu to operator.
showMenu()  : bool
Display ITR menu.

Methods

getBotMenu()

Returns stored data for ITR menu.

public static getBotMenu() : ItrMenu|null
Return values
ItrMenu|null

getMenuState()

Returns user's menu track.

public static getMenuState(string $dialogId) : array<string|int, mixed>|null
Parameters
$dialogId : string

User or chat id.

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

hasBotMenu()

Checks if bot has ITR menu.

public static hasBotMenu() : bool
Return values
bool

saveMenuState()

Saves user's menu track.

public static saveMenuState(string $dialogId, array<string|int, mixed> $menuState) : void
Parameters
$dialogId : string

User or chat id.

$menuState : array<string|int, mixed>

User menu track.

sendMenuResult()

Sends result of the user interaction with ITR menu to operator.

public static sendMenuResult(array<string|int, mixed> $params) : bool
Parameters
$params : array<string|int, mixed>

Command arguments.

[
  (int) BOT_ID Bot id.
  (string) DIALOG_ID Dialog id.
  (int) MESSAGE_ID Message id.
]
Return values
bool

showMenu()

Display ITR menu.

public static showMenu(array<string|int, mixed> $params) : bool
Parameters
$params : array<string|int, mixed>

Command arguments.

[
  (int) BOT_ID Bot id.
  (string) DIALOG_ID Dialog id.
  (int) MESSAGE_ID Previous message id.
  (string) COMMAND
  (string) COMMAND_PARAMS
  (bool) FULL_REDRAW Drop previous menu block.
]
.
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results