IMessageFilterBuilder

​

Interface IMessageFilterBuilder

interface IMessageFilterBuilder

Extends com.amazon.apmf.IStandard A builder for constructing message filters that can be installed via IMessagingModule::registerMessageFilter().

​

Methods

​

baseUri()

IMessageFilterBuilder* baseUri(string baseUri)

Constrains this filter to match only messages whose target URI is identical to the given baseUri. baseUri is a URI without query params or fragments.

​

Parameters

baseUri

string — Required The URI to compare incoming message’s targetUri against.

​

Returns

IMessageFilterBuilder* An IMessageFilterBuilder instance that can be used for further calls.

​

Throws

• com.amazon.apmf.InvalidArgumentError — for unsupported uris.

---

​

requiredPrivileges()

IMessageFilterBuilder* requiredPrivileges(string[] privileges)

Constrains this filter to accept only messages whose sender possesses all of the specified privileges.

​

Parameters

privileges

string[] — Required The list of privileges that the message sender must possess.

​

Returns

IMessageFilterBuilder* An IMessageFilterBuilder instance that can be used for further calls.

---

​

build()

IMessageFilter* build()

Builds a new IMessageFilter.

​

Returns

IMessageFilter* An IMessageFilter instance that can be registered.

---