Интерфейс MessageParameter

Граф наследования:MessageParameter:

Открытые члены
	setMessageId (int $messageId)
	getMessageId ()
	setName (string $name)
	getName ()
	setType (string $type)
	getType ()
	setValue ($value)
	getDefaultValue ()
	hasValue ()
	getValue ()
	addValue ($value)
	unsetValue ()
	isHidden ()
	toRestFormat ()
	toPullFormat ()
	isValid ()
	isDeleted ()

Подробное описание

См. определение в файле MessageParameter.php строка 7

Методы

addValue()

addValue

(

$value

)

Аргументы

mixed

$value

Возвращает

static

Замещается в Param, AttachArray и ParamArray.

getDefaultValue()

getDefaultValue

(

)

Возвращает

mixed|null

Замещается в Param, Keyboard, Menu и ParamArray.

getMessageId()

getMessageId

(

)

Замещается в Param и ParamArray.

getName()

getName

(

)

Возвращает

string|null

Замещается в Param и ParamArray.

getType()

getType

(

)

Возвращает

string

Замещается в Param и ParamArray.

getValue()

getValue

(

)

Возвращает

mixed|null

Замещается в Param, Attach, AttachArray, DateTime, Keyboard, Menu, TextDate, UserAvatar, UserName и ParamArray.

hasValue()

hasValue

(

)

Возвращает

bool

Замещается в Param и ParamArray.

isDeleted()

isDeleted

(

)

Замещается в ParamArray.

isHidden()

isHidden

(

)

Возвращает

bool

Замещается в Param и ParamArray.

isValid()

isValid

(

)

Возвращает

Result

Замещается в Param, Attach, Keyboard, Menu и ParamArray.

setMessageId()

setMessageId

(

int

$messageId

)

Замещается в Param и ParamArray.

setName()

setName

(

string

$name

)

См. также

\Bitrix\Im\V2\Message\Params for common names.

Аргументы

string

$name

Возвращает

$this

Замещается в Param и ParamArray.

setType()

setType

(

string

$type

)

См. также

\Bitrix\Im\V2\Message\Param for scalar papam types.

Аргументы

string

$type

Возвращает

$this

Замещается в Param и ParamArray.

setValue()

setValue

(

$value

)

Аргументы

mixed

$value

Возвращает

static

Замещается в Param, Attach, ComponentParams, DateTime, Keyboard, Menu, AttachArray и ParamArray.

toPullFormat()

toPullFormat

(

)

Возвращает

string|array|null

Замещается в Param, Attach, AttachArray, ComponentParams, Keyboard, Menu, UserAvatar и ParamArray.

toRestFormat()

toRestFormat

(

)

Возвращает

string|array|null

Замещается в Param, Attach, AttachArray, ComponentParams, DateTime, Keyboard, Menu и ParamArray.

unsetValue()

unsetValue

(

)

Возвращает

static

Замещается в Param.