Bitrix API

CopilotButton extends Button

FinalYes

Table of Contents

Constants

SCOPE_MOBILE  = 'mobile'
SCOPE_WEB  = 'web'
STATE_AI_LOADING  = 'ai-loading'
STATE_AI_SUCCESS  = 'ai-success'
STATE_DEFAULT  = 'default'
STATE_DISABLED  = 'disabled'
STATE_HIDDEN  = 'hidden'
STATE_LOADING  = 'loading'
STATE_LOCKED  = 'locked'
TYPE_AI  = 'ai'
TYPE_PRIMARY  = 'primary'
TYPE_SECONDARY  = 'secondary'

Methods

__construct()  : mixed
getAction()  : Action|null
getHideIfReadonly()  : bool|null
getIcon()  : string|null
getMenuItems()  : array<string|int, mixed>|null
getProps()  : array<string|int, mixed>|null
getScope()  : string|null
getSort()  : int|null
getState()  : string|null
getTitle()  : string
getTooltip()  : string|null
getType()  : string
setAction()  : self
setHideIfReadonly()  : self
setIcon()  : self
setMenuItems()  : self
setProps()  : self
setScope()  : self
setScopeMobile()  : self
setScopeWeb()  : self
setSort()  : self
setState()  : self
setStateDisabled()  : self
setStateHidden()  : self
setTooltip()  : self
setType()  : self
toArray()  : array<string|int, mixed>

Constants

SCOPE_MOBILE

public mixed SCOPE_MOBILE = 'mobile'

SCOPE_WEB

public mixed SCOPE_WEB = 'web'

STATE_AI_LOADING

public mixed STATE_AI_LOADING = 'ai-loading'

STATE_AI_SUCCESS

public mixed STATE_AI_SUCCESS = 'ai-success'

STATE_DEFAULT

public mixed STATE_DEFAULT = 'default'

STATE_DISABLED

public mixed STATE_DISABLED = 'disabled'

STATE_HIDDEN

public mixed STATE_HIDDEN = 'hidden'

STATE_LOADING

public mixed STATE_LOADING = 'loading'

STATE_LOCKED

public mixed STATE_LOCKED = 'locked'

TYPE_AI

public mixed TYPE_AI = 'ai'

TYPE_PRIMARY

public mixed TYPE_PRIMARY = 'primary'

TYPE_SECONDARY

public mixed TYPE_SECONDARY = 'secondary'

Methods

getHideIfReadonly()

public getHideIfReadonly() : bool|null
Return values
bool|null

getIcon()

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

getMenuItems()

public getMenuItems() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getProps()

public getProps() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getScope()

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

getSort()

public getSort() : int|null
Return values
int|null

getState()

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

getTitle()

public getTitle() : string
Return values
string

getTooltip()

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

getType()

public getType() : string
Return values
string

setAction()

public setAction(Action|null $action) : self
Parameters
$action : Action|null
Return values
self

setHideIfReadonly()

public setHideIfReadonly([bool|null $hideIfReadonly = true ]) : self
Parameters
$hideIfReadonly : bool|null = true
Return values
self

setIcon()

public setIcon(string $icon) : self
Parameters
$icon : string
Return values
self

setMenuItems()

public setMenuItems(array<string|int, mixed>|null $menuItems) : self
Parameters
$menuItems : array<string|int, mixed>|null
Return values
self

setProps()

public setProps(array<string|int, mixed>|null $props) : self
Parameters
$props : array<string|int, mixed>|null
Return values
self

setScope()

public setScope(string|null $scope) : self
Parameters
$scope : string|null
Return values
self

setScopeMobile()

public setScopeMobile() : self
Return values
self

setScopeWeb()

public setScopeWeb() : self
Return values
self

setSort()

public setSort(int $sort) : self
Parameters
$sort : int
Return values
self

setState()

public setState(string|null $state) : self
Parameters
$state : string|null
Return values
self

setStateDisabled()

public setStateDisabled() : self
Return values
self

setStateHidden()

public setStateHidden() : self
Return values
self

setTooltip()

public setTooltip(string|null $hint) : self
Parameters
$hint : string|null
Return values
self

setType()

public setType(string $type) : self
Parameters
$type : string
Return values
self

toArray()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results