nodes/generated

Interface MattermostV1NodeParameters

Source
interface MattermostV1NodeParameters {
    additionalFields?:
        | {
            first_name?: string;
            last_name?: string;
            locale?: string;
            nickname?: string;
            notificationUi?: {
                notificationValues: {
                    channel?: boolean;
                    desktop?: "all"
                    | "none"
                    | "mention";
                    desktop_sound?: boolean;
                    email?: boolean;
                    first_name?: boolean;
                    mention_keys?: string;
                    push?: "all" | "none" | "mention";
                };
            };
        }
        | {
            inChannel?: string;
            inTeam?: string;
            notInChannel?: string;
            notInTeam?: string;
            sort?: | "status"
            | "username"
            | "createdAt"
            | "lastActivityAt";
        }
        | { since?: string };
    attachments?: {
        actions?: {
            item: {
                data_source?: "custom" | "users" | "channels";
                integration?: {
                    item: {
                        context?: { property: ... };
                        url?: string;
                    };
                };
                name?: string;
                options?: {
                    option: {
                        text?: (...)
                        | (...);
                        value?: (...) | (...);
                    }[];
                };
                type?: "select"
                | "button";
            }[];
        };
        author_icon?: string;
        author_link?: string;
        author_name?: string;
        color?: string;
        fallback?: string;
        fields?: {
            item: {
                short?: boolean;
                title?: string;
                value?: string;
            }[];
        };
        footer?: string;
        footer_icon?: string;
        image_url?: string;
        pretext?: string;
        text?: string;
        thumb_url?: string;
        title?: string;
        title_link?: string;
    };
    authData?: string;
    authService?: | "email"
    | "google"
    | "ldap"
    | "gitlab"
    | "office365"
    | "saml";
    channel?: string;
    channelId?: string;
    displayName?: string;
    email?: string;
    emails?: string;
    emojiName?: string;
    limit?: number;
    message?: string;
    operation?: | "create"
    | "getAll"
    | "delete"
    | "search"
    | "post"
    | "invite"
    | "addUser"
    | "members"
    | "restore"
    | "statistics"
    | "postEphemeral"
    | "deactive"
    | "getByEmail"
    | "getById";
    otherOptions?: { root_id?: string };
    password?: string;
    postId?: string;
    resolveData?: boolean;
    resource?: "message" | "user" | "channel" | "reaction";
    returnAll?: boolean;
    teamId?: string;
    term?: string;
    type?: "public" | "private";
    userId?: string;
    userIds?: string;
    username?: string;
}

Properties§

§readonly additionalFields?:
    | {
        first_name?: string;
        last_name?: string;
        locale?: string;
        nickname?: string;
        notificationUi?: {
            notificationValues: {
                channel?: boolean;
                desktop?: "all"
                | "none"
                | "mention";
                desktop_sound?: boolean;
                email?: boolean;
                first_name?: boolean;
                mention_keys?: string;
                push?: "all" | "none" | "mention";
            };
        };
    }
    | {
        inChannel?: string;
        inTeam?: string;
        notInChannel?: string;
        notInTeam?: string;
        sort?: | "status"
        | "username"
        | "createdAt"
        | "lastActivityAt";
    }
    | { since?: string }

Default: {}

§readonly attachments?: { ... }

The attachment to add Default: {} Type options: {"multipleValues":true,"multipleValueButtonText":"Add attachment"}

§readonly authData?: string
§readonly authService?:
    | "email"
    | "google"
    | "ldap"
    | "gitlab"
    | "office365"
    | "saml"
§readonly channel?: string

The unique handle for the channel, will be present in the channel URL

§readonly channelId?: string

The ID of the channel to soft delete. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getChannels"}

§readonly displayName?: string

The non-unique UI name for the channel

§readonly email?: string
§readonly emails?: string

User's email. Multiple emails can be set separated by comma.

§readonly emojiName?: string

Emoji to use for this reaction

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":100}

§readonly message?: string

The text to send

§readonly operation?:
    | "create"
    | "getAll"
    | "delete"
    | "search"
    | "post"
    | "invite"
    | "addUser"
    | "members"
    | "restore"
    | "statistics"
    | "postEphemeral"
    | "deactive"
    | "getByEmail"
    | "getById"

Default: "create"

§readonly otherOptions?: { ... }

Other options to set Default: {}

§readonly password?: string

The password used for email authentication Type options: {"password":true}

§readonly postId?: string

ID of the post to delete

§readonly resolveData?: boolean

By default the response only contain the ID of the user. If this option gets activated, it will resolve the user automatically. Default: true

§readonly resource?: "message" | "user" | "channel" | "reaction"

Default: "message"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit Default: true

§readonly teamId?: string

The Mattermost Team. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getTeams"}

§readonly term?: string

The search term for Channels in a Team

§readonly type?: "public" | "private"

The type of channel to create Default: "public"

§readonly userId?: string

The ID of the user to invite into channel. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getUsers"}

§readonly userIds?: string

User's ID

§readonly username?: string