Skip to main content
Version: Next

ViewMessages

Search and display a list of messages (for example in a chat application or CRM) to the user.

Intent Name

ViewMessages

Display Name

View Messages

Possible Contexts

Example

Request display of messages relating to a specific fdc3.instrument (representing a ticker):

const searchCriteria = {
type: "fdc3.chat.searchCriteria",
criteria: [
{
type: "fdc3.instrument",
id: {
ticker: "AAPL"
}
}
]
}

fdc3.raiseIntent('ViewMessages', searchCriteria);

Request display of messages relating to a specific fdc3.contact:

const searchCriteria = {
type: "fdc3.chat.searchCriteria",
criteria: [
{
type: "fdc3.contact",
name: "Jane Doe",
id: {
email: "jane.doe@mail.com"
}
}
]
}

fdc3.raiseIntent('ViewMessages', searchCriteria);

Request display of messages relating to a specific fdc3.organization:

const searchCriteria = {
type: "fdc3.chat.searchCriteria",
criteria: [
{
type: "fdc3.organization",
name: "Symphony"
}
]
}

fdc3.raiseIntent('ViewMessages', searchCriteria);

Request display of messages relating to a specific phrase:

const searchCriteria = {
type: "fdc3.chat.searchCriteria",
criteria: [
"#OrderID45788422"
]
}

fdc3.raiseIntent('ViewMessages', searchCriteria);

Request display of messages matching multiple criteria:

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

fdc3.raiseIntent('ViewMessages', searchCriteria);

See Also

Context

Intents