Skip to content

Class: MessageParameters ​

Builder for constructing a list of MessageParameters. Mirrors the SetupOptions builder pattern.

Constructors ​

Constructor ​

new MessageParameters(): MessageParameters

Returns ​

MessageParameters

Methods ​

add() ​

add(param): this

Parameters ​

param ​

MessageParameter

Returns ​

this


addAuthorizationToken() ​

addAuthorizationToken(token): this

Parameters ​

token ​

AuthorizationToken

Returns ​

this


addExpires() ​

addExpires(expires): this

Parameters ​

expires ​

number | bigint

Returns ​

this


addFillParameters() ​

addFillParameters(parameters): this

Parameters ​

parameters ​

MessageParameter[]

Returns ​

this


addFillTimeout() ​

addFillTimeout(timeout): this

Parameters ​

timeout ​

number | bigint

Returns ​

this


addForward() ​

addForward(forward): this

Parameters ​

forward ​

boolean

Returns ​

this


addGroupOrder() ​

addGroupOrder(order): this

Parameters ​

order ​

Ascending | Descending

Returns ​

this


addIncludeProperties() ​

addIncludeProperties(include): this

Parameters ​

include ​

boolean

Returns ​

this


addLocationFilter() ​

addLocationFilter(filter): this

Parameters ​

filter ​

LocationFilter

Returns ​

this


addNewGroupRequest() ​

addNewGroupRequest(group): this

Parameters ​

group ​

number | bigint

Returns ​

this


addObjectDeliveryTimeout() ​

addObjectDeliveryTimeout(timeout): this

Parameters ​

timeout ​

number | bigint

Returns ​

this


addRangeFilter() ​

addRangeFilter(filter): this

Parameters ​

filter ​

RangeFilter

Returns ​

this


addRendezvousTimeout() ​

addRendezvousTimeout(timeout): this

Parameters ​

timeout ​

number | bigint

Returns ​

this


addSubgroupDeliveryTimeout() ​

addSubgroupDeliveryTimeout(timeout): this

Parameters ​

timeout ​

number | bigint

Returns ​

this


addSubscriberPriority() ​

addSubscriberPriority(priority): this

Parameters ​

priority ​

number

Returns ​

this


addSwitchFrom() ​

addSwitchFrom(requestId, mode, publishDone): this

Parameters ​

requestId ​

number | bigint

mode ​

SwitchMode

publishDone ​

boolean

Returns ​

this


build() ​

build(): MessageParameter[]

Returns ​

MessageParameter[]


fromKeyValuePairs() ​

static fromKeyValuePairs(pairs): MessageParameter[]

Parses an array of KeyValuePairs into a list of MessageParameters. Unrecognized parameter types are silently skipped. Known parameter types with invalid values still throw ProtocolViolationError.

Parameters ​

pairs ​

KeyValuePair[]

Returns ​

MessageParameter[]