Bitrix API

General extends BaseSettings

Table of Contents

Constants

OPEN_DESKTOP_FROM_PANEL  = 'openDesktopFromPanel'
PRIVACY_SEARCH  = 'privacySearch'
SCHEME  = 'notifyScheme'
SIMPLE_MAIL  = 'notifySchemeSendEmail'
SIMPLE_PUSH  = 'notifySchemeSendPush'
SIMPLE_SITE  = 'notifySchemeSendSite'

Methods

__construct()  : mixed
fillDataBase()  : BaseSettings
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
getSettings()  : Result<string|int, array<string|int, mixed>>
getSimpleNotifyScheme()  : array<string|int, mixed>
isLoad()  : bool
isSimpleNotifySchema()  : bool
load()  : $this
shouldUpdateSimpleNotifySettings()  : bool
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.
updateSetting()  : void

Constants

OPEN_DESKTOP_FROM_PANEL

public mixed OPEN_DESKTOP_FROM_PANEL = 'openDesktopFromPanel'
public mixed PRIVACY_SEARCH = 'privacySearch'

SCHEME

public mixed SCHEME = 'notifyScheme'

SIMPLE_MAIL

public mixed SIMPLE_MAIL = 'notifySchemeSendEmail'

SIMPLE_PUSH

public mixed SIMPLE_PUSH = 'notifySchemeSendPush'

SIMPLE_SITE

public mixed SIMPLE_SITE = 'notifySchemeSendSite'

Methods

__construct()

public __construct(int|null $groupId) : mixed
Parameters
$groupId : int|null

getRestEntityName()

Returns the name of the entity that will be used in the rest response

public static getRestEntityName() : string
Return values
string

getSettings()

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

getSimpleNotifyScheme()

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

isSimpleNotifySchema()

public isSimpleNotifySchema() : bool
Return values
bool

load()

public load(int|array<string|int, mixed> $source) : $this
Parameters
$source : int|array<string|int, mixed>
Return values
$this

shouldUpdateSimpleNotifySettings()

public shouldUpdateSimpleNotifySettings(array<string|int, mixed> $settingsConfiguration) : bool
Parameters
$settingsConfiguration : array<string|int, mixed>
Return values
bool

toRestFormat()

Returns an array in JSON like format to return the entity as a rest response.

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

updateSetting()

public updateSetting(array{name: string, value: string|bool} $settingConfiguration) : void
Parameters
$settingConfiguration : array{name: string, value: string|bool}
Tags
throws
Exception

        
On this page

Search results