Bitrix API

NetworkMenuBot

The implement of the Imbot\Bot\MenuBot interface.

Table of Contents

Methods

getMenuCommandList()  : array<string|int, array{class: string, handler: string, visible: bool, context: string}>
Returns command's property list.
getMenuState()  : array<string|int, mixed>|null
Returns user's menu track.
handleMenuCommand()  : void
instanceMenu()  : ItrMenu
isMenuTrackFinished()  : bool
Checks if menu track has been completed.
isMenuTrackStarted()  : bool
Checks if menu track has been started.
resetMenuState()  : void
Clears user's menu track.
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.
stopMenuTrack()  : void
Stops show menu to user.

Methods

getMenuCommandList()

Returns command's property list.

public static getMenuCommandList() : array<string|int, array{class: string, handler: string, visible: bool, context: string}>
Return values
array<string|int, array{class: string, handler: string, visible: bool, context: string}>

getMenuState()

Returns user's menu track.

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

User or id.

Tags
see
MenuBot::getMenuState
Return values
array<string|int, mixed>|null

handleMenuCommand()

public static handleMenuCommand(int $messageId, array<string|int, mixed> $messageFields) : void
Parameters
$messageId : int
$messageFields : array<string|int, mixed>

instanceMenu()

public static instanceMenu() : ItrMenu
Return values
ItrMenu

isMenuTrackFinished()

Checks if menu track has been completed.

public static isMenuTrackFinished(string $dialogId) : bool
Parameters
$dialogId : string

User or chat id.

Return values
bool

isMenuTrackStarted()

Checks if menu track has been started.

public static isMenuTrackStarted(string $dialogId) : bool
Parameters
$dialogId : string

User or chat id.

Return values
bool

resetMenuState()

Clears user's menu track.

public static resetMenuState(string $dialogId) : void
Parameters
$dialogId : string

User or chat id.

saveMenuState()

Saves user's menu track.

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

User or chat id.

$menuState : array<string|int, mixed>|null = null

User menu track.

Tags
see
MenuBot::saveMenuState

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.

[
  (string) DIALOG_ID Dialog id.
  (int) MESSAGE_ID Message id.
  (array) PARAMS Some extra action data.
]
Tags
see
MenuBot::sendMenuResult
Return values
bool

showMenu()

Display ITR menu.

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

Command arguments.

[
  (string) DIALOG_ID Dialog id.
  (int) MESSAGE_ID Previous message id.
  (string) COMMAND
  (string) COMMAND_PARAMS
  (bool) FULL_REDRAW Drop previous menu block.
]
.
Tags
see
MenuBot::showMenu
Return values
bool

stopMenuTrack()

Stops show menu to user.

public static stopMenuTrack(string $dialogId) : void
Parameters
$dialogId : string

User or chat id.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results