n8n/packages/nodes-base/nodes/Matrix/MessageDescription.ts

267 lines
4.9 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const messageOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'message',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Send a message to a room',
},
{
name: 'Get All',
value: 'getAll',
description: 'Gets all messages from a room',
},
],
default: 'create',
description: 'The operation to perform.',
},
];
export const messageFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* message:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Room ID',
name: 'roomId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
default: '',
placeholder: '!123abc:matrix.org',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'message',
],
},
},
required: true,
description: 'The channel to send the message to.',
},
{
displayName: 'Text',
name: 'text',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
placeholder: 'Hello from n8n!',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'message',
],
},
},
description: 'The text to send.',
},
{
displayName: 'Message Type',
name: 'messageType',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'message',
],
},
},
type: 'options',
options: [
{
name: 'Emote',
value: 'm.emote',
description: 'Perform an action (similar to /me in IRC).',
},
{
name: 'Notice',
value: 'm.notice',
description: 'Send a notice.',
},
{
name: 'Text',
value: 'm.text',
description: 'Send a text message.',
},
],
default: 'm.text',
description: 'The type of message to send.',
},
{
displayName: 'Message Format',
name: 'messageFormat',
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'message',
],
},
},
type: 'options',
options: [
{
name: 'Plain Text',
value: 'plain',
description: 'Text only',
},
{
name: 'HTML',
value: 'org.matrix.custom.html',
description: 'HTML-formatted text',
},
],
default: 'plain',
description: `The format of the message's body.`,
},
{
displayName: 'Fallback Text',
name: 'fallbackText',
default: '',
displayOptions: {
show: {
resource: [
'message',
],
operation: [
'create',
],
messageFormat: [
'org.matrix.custom.html',
],
},
},
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
description: 'A plain text message to display in case the HTML cannot be rendered by the Matrix client.',
},
/* ----------------------------------------------------------------------- */
/* message:getAll */
/* ----------------------------------------------------------------------- */
{
displayName: 'Room ID',
name: 'roomId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getChannels',
},
displayOptions: {
show: {
resource: [
'message',
],
operation: [
'getAll',
],
},
},
description: 'The token to start returning events from. This token can be obtained from a prev_batch token returned for each room by the sync API',
required: true,
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: [
'message',
],
operation: [
'getAll',
],
},
},
description: 'If all results should be returned or only up to a given limit.',
required: true,
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'message',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 500,
},
default: 100,
description: 'How many results to return.',
},
{
displayName: 'Other Options',
name: 'otherOptions',
type: 'collection',
displayOptions: {
show: {
resource: [
'message',
],
operation: [
'getAll',
],
},
},
default: {},
description: 'Other options',
placeholder: 'Add options',
options: [
{
displayName: 'Filter',
name: 'filter',
type: 'string',
default: '',
description: 'A JSON RoomEventFilter to filter returned events with. More information can be found on this <a href="https://matrix.org/docs/spec/client_server/r0.6.0">page</a>.',
placeholder: '{"contains_url":true,"types":["m.room.message", "m.sticker"]}',
},
],
},
];