ChannelExtensions

ChannelExtensions

This represents a set of channel-specific extension properties.

Constructor

new ChannelExtensions()

Source:

typings/lib2/messagev2/common/channelExtensions.js, line 21

Methods

getExtensionProperty(channelType, propertyName) → {any}

Description:

Get a channel-specific extension property.

Source:

typings/lib2/messagev2/common/channelExtensions.js, line 45

Parameters:

Name	Type	Description
`channelType`	ChannelType	The channel type.
`propertyName`	string	The name of the property.

Returns:

The value of the property.

Type: any

hasExtensionProperty(channelType, propertyName) → {boolean}

Description:

Check whether a channel-specific extension property is defined or not.

Source:

typings/lib2/messagev2/common/channelExtensions.js, line 58

Parameters:

Name	Type	Description
`channelType`	ChannelType	The channel type.
`propertyName`	string	The name of the property.

Returns:

flag that indicates if the property is set

Type: boolean

setExtensionProperty(channelType, propertyName, propertyValue)

Description:

Set a new channel-specific extension property.

Source:

typings/lib2/messagev2/common/channelExtensions.js, line 28

Parameters:

Name	Type	Description
`channelType`	ChannelType	The channel type.
`propertyName`	string	The name of the property.
`propertyValue`	any	The value of the property.