Class MessageFilter

Structured description of Message values to be matched. A MessageFilter can match against actions and categories in a Message.

api-version: 1
user

Hierarchy

MessageFilter

Index

Constructors

constructor

Properties

Methods

match

Constructors

constructor

new MessageFilter(args: { action?: string; category?: string; componentId?: string; packageName?: string }): MessageFilter

- Defined in src/api/dart-api.ts:7328
Parameters
- args: { action?: string; category?: string; componentId?: string; packageName?: string }
  - Optional action?: string
  - Optional category?: string
  - Optional componentId?: string
  - Optional packageName?: string
Returns MessageFilter

Properties

Optional Readonly action

action?: string

The action to match, such as Message.ACTION_MAIN.

api-version: 1
user

Optional Readonly category

category?: string

The category to match, such as Message.CATEGORY_SCREEN.

api-version: 1
user

Optional Readonly componentId

componentId?: string

The component id to match.

api-version: 1
user

Optional Readonly packageName

packageName?: string

The packageName to match.

api-version: 1
user

Methods

match

match(message: Message): boolean

- Defined in src/api/dart-api.ts:7344
Whether this filter matches the given message.

api-version
1

user
Parameters
- message: Message
  
  The message to compare with this filter.
Returns boolean
Return true if the message's action and category are matched with the action and category.

Generated using TypeDoc