Bitrix API

Pin extends AbstractSwitcher

Table of Contents

Constants

PIN_CONTEXT  = ''
TYPE_OFF  = 'N'
TYPE_ON  = 'Y'

Methods

__construct()  : mixed
disable()  : Result
enable()  : Result
get()  : SwitcherInterface
getCode()  : string
getDefaultCode()  : string
getMessage()  : string|null
getPinnedMessage()  : string|null
getSpaceId()  : int|null
getUnpinnedMessage()  : string|null
getUserId()  : int
getValue()  : string
invalidate()  : void
isEnabled()  : bool
switch()  : Result

Constants

PIN_CONTEXT

public mixed PIN_CONTEXT = ''

Methods

__construct()

public __construct(int $userId, int|null $spaceId, string $code) : mixed
Parameters
$userId : int
$spaceId : int|null
$code : string

disable()

public disable() : Result
Return values
Result

enable()

public enable() : Result
Return values
Result

getDefaultCode()

public static getDefaultCode() : string
Return values
string

getMessage()

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

getPinnedMessage()

public static getPinnedMessage() : string|null
Return values
string|null

getUnpinnedMessage()

public static getUnpinnedMessage() : string|null
Return values
string|null

getValue()

public getValue() : string
Return values
string

        
On this page

Search results