Bitrix API

SupportQuestion

Table of Contents

Methods

addSupportQuestion()  : int
Starts new question dialog.
allowAdditionalQuestion()  : bool
Permits adding new additional question.
getQuestionAppList()  : array<string|int, array{command: string, icon: string, js: string, context: string, lang: string}>
Returns app's property list for questioning.
getQuestionDisallowMessage()  : string
Returns question disallow message to display for user.
getQuestionResumeButton()  : Keyboard
Returns button for session resume.
getQuestionsCount()  : int
getQuestionsWithUnreadMessages()  : array<string|int, mixed>
getSupportQuestionConfig()  : array<string|int, mixed>
Returns configuration flags for client.
getSupportQuestionList()  : array{id: int, title: string}
Returns the question dialog list and perfoms searching by question dialog title.
incrementGlobalQuestionCounter()  : int
Increments global for portal question counter.
isEnabledQuestionFunctional()  : bool
Tells true if additional question functional is enabled.

Methods

addSupportQuestion()

Starts new question dialog.

public static addSupportQuestion([int $userId = 0 ][, bool $showMenu = true ][, bool $fromOperator = false ]) : int
Parameters
$userId : int = 0
$showMenu : bool = true
$fromOperator : bool = false
Return values
int

allowAdditionalQuestion()

Permits adding new additional question.

public static allowAdditionalQuestion([int|null $botId = null ]) : bool
Parameters
$botId : int|null = null
Return values
bool

getQuestionAppList()

Returns app's property list for questioning.

public static getQuestionAppList() : array<string|int, array{command: string, icon: string, js: string, context: string, lang: string}>
Return values
array<string|int, array{command: string, icon: string, js: string, context: string, lang: string}>

getQuestionDisallowMessage()

Returns question disallow message to display for user.

public static getQuestionDisallowMessage() : string
Return values
string

getQuestionsCount()

public static getQuestionsCount([int|null $botId = null ][, int|null $userId = null ]) : int
Parameters
$botId : int|null = null
$userId : int|null = null
Return values
int

getQuestionsWithUnreadMessages()

public static getQuestionsWithUnreadMessages([int|null $botId = null ]) : array<string|int, mixed>
Parameters
$botId : int|null = null
Return values
array<string|int, mixed>

getSupportQuestionConfig()

Returns configuration flags for client.

public static getSupportQuestionConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSupportQuestionList()

Returns the question dialog list and perfoms searching by question dialog title.

public static getSupportQuestionList(array<string|int, mixed> $params) : array{id: int, title: string}
Parameters
$params : array<string|int, mixed>

Query parameters.

[
	(string) searchQuery - String to search by title.
	(int) limit - Number rows to select.
	(int) offset - Set starting offset.
]
Return values
array{id: int, title: string}

incrementGlobalQuestionCounter()

Increments global for portal question counter.

public static incrementGlobalQuestionCounter() : int
Return values
int

isEnabledQuestionFunctional()

Tells true if additional question functional is enabled.

public static isEnabledQuestionFunctional() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results