ChatSearchCriteria

A context type that represents a simple search criterion, based on a list of other context objects, that can be used to search or filter messages in a chat application.

Type

fdc3.chat.searchCriteria

Schema

https://fdc3.finos.org/schemas/2.1/context/chatSearchCriteria.schema.json https://fdc3.finos.org/schemas/2.1/context/chatSearchCriteria.schema.json

Details

Property	Type	Required	Example Value
type	string	Yes	'fdc3.chat.searchCriteria'
criteria	(Instrument | Contact | Organization | string)[]	Yes	[   {     "type": "fdc3.instrument",     "id": {       "ticker": "AAPL"     }   },   {     "type": "fdc3.contact",     "name":"Jane Doe",     "id": {       "email": "jane.doe@mail.com"     }   },   {     "type": "fdc3.organization",     "name":"Symphony",   },   "#OrderID45788422", ]

⚠️ Operators (and/or/not) are not defined in fdc3.chat.searchCriteria. It is up to the application that processes the FDC3 Intent to choose and apply the operators between the criteria.

Empty search criteria can be supported to allow resetting of filters.

Example

const searchCriteria = {
    type: "fdc3.chat.searchCriteria",
    criteria: [
        {
            type: "fdc3.instrument",
            id: {
                ticker: "AAPL"
            }
        },
        {
            type: "fdc3.contact",
            name: "Jane Doe",
            id: {
                email: "jane.doe@mail.com"
            }
        },
        {
            type: "fdc3.organization",
            name: "Symphony"
        },
        "#OrderID45788422"
    ]
}

fdc3.raiseIntent('ViewMessages', searchCriteria);

See Also

Intents

• ViewMessages