Interface MicrosoftTeamsV2NodeParameters

Source
interface MicrosoftTeamsV2NodeParameters {
    approvalOptions?: {
        values: {
            approvalType?: "single" | "double";
            approveLabel?: string;
            disapproveLabel?: string;
        };
    };
    bucketId?: { mode: "id"
    | "list"; value: string };
    channelId?: { mode: "id" | "list"; value: string };
    chatId?: { mode: "id" | "list"; value: string };
    contentType?: "text" | "html";
    defineForm?: "json" | "fields";
    formFields?: {
        values: {
            acceptFileTypes?: string;
            elementName?: string;
            fieldLabel: string;
            fieldName?: string;
            fieldOptions: { values: { option?: string }[] };
            fieldType:
                | "number"
                | "file"
                | "text"
                | "email"
                | "date"
                | "html"
                | "checkbox"
                | "dropdown"
                | "hiddenField"
                | "password"
                | "radio"
                | "textarea";
            fieldValue?: string;
            formatDate?: string;
            html?: string;
            limitSelection?: "exact"
            | "range"
            | "unlimited";
            maxSelections?: number;
            minSelections?: number;
            multipleFiles?: boolean;
            multiselect?: boolean;
            multiselectLegacyNotice?: string;
            numberOfSelections?: number;
            placeholder?: string;
            requiredField?: boolean;
        }[];
    };
    groupId?: { mode: "id"
    | "list"; value: string };
    jsonOutput?: string;
    limit?: number;
    message?: string;
    messageId?: string;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "sendAndWait"
        | "deleteChannel"
        | "deleteTask";
    options?: | {
        description?: string;
        type?: "private"
        | "standard";
    }
    | { description?: string }
    | {
        includeLinkToWorkflow?: boolean;
        makeReply?: string;
    }
    | { includeLinkToWorkflow?: boolean }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?:
                    | "afterTimeInterval"
                    | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
        messageButtonLabel?: string;
        responseFormButtonLabel?: string;
        responseFormCustomCss?: string;
        responseFormDescription?: string;
        responseFormTitle?: string;
    }
    | {
        assignedTo?: { mode: "id"
        | "list"; value: string };
        dueDateTime?: string;
        percentComplete?: number;
    };
    planId?: { mode: "id"
    | "list"; value: string };
    resource?:
        | "task"
        | "channel"
        | "channelMessage"
        | "chatMessage";
    responseType?: "approval"
    | "freeText"
    | "customForm";
    returnAll?: boolean;
    taskId?: string;
    tasksFor?: "member" | "plan";
    teamId?: { mode: "id" | "list" | "url"; value: string };
    title?: string;
    updateFields?: {
        assignedTo?: { mode: "id" | "list"; value: string };
        bucketId?: { mode: "id" | "list"; value: string };
        dueDateTime?: string;
        groupId?: { mode: "id" | "list"; value: string };
        percentComplete?: number;
        planId?: { mode: "id" | "list"; value: string };
        title?: string;
    };
}

Properties§

Source§

readonly approvalOptions?: {
    values: {
        approvalType?: "single" | "double";
        approveLabel?: string;
        disapproveLabel?: string;
    };
}

Default: {}

Source§

readonly bucketId?: { mode: "id" | "list"; value: string }

The bucket for the task to belong to Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["planId.value"]}

Source§

readonly channelId?: { mode: "id" | "list"; value: string }

Select the channel from the list, by URL, or by ID (the ID is the "threadId" in the URL) Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["teamId.value"]}

Source§

readonly chatId?: { mode: "id" | "list"; value: string }

Select the chat from the list, by URL, or by ID (find the chat ID after "conversations/" in the URL) Default: {"mode":"list","value":""}

Source§

readonly contentType?: "text" | "html"

Whether the message is plain text or HTML Default: "text"

Source§

readonly defineForm?: "json" | "fields"

Default: "fields"

Source§

readonly formFields?: {
    values: {
        acceptFileTypes?: string;
        elementName?: string;
        fieldLabel: string;
        fieldName?: string;
        fieldOptions: { values: { option?: string }[] };
        fieldType:
            | "number"
            | "file"
            | "text"
            | "email"
            | "date"
            | "html"
            | "checkbox"
            | "dropdown"
            | "hiddenField"
            | "password"
            | "radio"
            | "textarea";
        fieldValue?: string;
        formatDate?: string;
        html?: string;
        limitSelection?: "exact"
        | "range"
        | "unlimited";
        maxSelections?: number;
        minSelections?: number;
        multipleFiles?: boolean;
        multiselect?: boolean;
        multiselectLegacyNotice?: string;
        numberOfSelections?: number;
        placeholder?: string;
        requiredField?: boolean;
    }[];
}

Default: {} Type options: {"multipleValues":true,"sortable":true}

Source§

readonly groupId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["groupSource"]}

Source§

readonly jsonOutput?: string

Default: "[\n {\n "fieldLabel":"Name",\n "placeholder":"enter you name",\n "requiredField":true\n },\n {\n "fieldLabel":"Age",\n "fieldType":"number",\n "placeholder":"enter your age"\n },\n {\n "fieldLabel":"Email",\n "fieldType":"email",\n "requiredField":true\n }\n]" Type options: {"rows":5}

Source§

readonly limit?: number

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

Source§

readonly message?: string

The content of the message to be sent Type options: {"rows":2}

Source§

readonly messageId?: string

The ID of the message to retrieve

Source§

readonly name?: string

The name of the new channel you want to create

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "sendAndWait"
    | "deleteChannel"
    | "deleteTask"

Default: "create"

Source§

readonly options?:
    | {
        description?: string;
        type?: "private"
        | "standard";
    }
    | { description?: string }
    | {
        includeLinkToWorkflow?: boolean;
        makeReply?: string;
    }
    | { includeLinkToWorkflow?: boolean }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?:
                    | "afterTimeInterval"
                    | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
        messageButtonLabel?: string;
        responseFormButtonLabel?: string;
        responseFormCustomCss?: string;
        responseFormDescription?: string;
        responseFormTitle?: string;
    }
    | {
        assignedTo?: { mode: "id"
        | "list"; value: string };
        dueDateTime?: string;
        percentComplete?: number;
    }

Default: {}

Source§

readonly planId?: { mode: "id" | "list"; value: string }

The plan for the task to belong to Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["groupId.value"]}

Source§

readonly resource?: "task" | "channel" | "channelMessage" | "chatMessage"

Default: "channel"

Source§

readonly responseType?: "approval" | "freeText" | "customForm"

Default: "approval"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly taskId?: string

The ID of the task to delete

Source§

readonly tasksFor?: "member" | "plan"

Whether to retrieve the tasks for a user or for a plan Default: "member"

Source§

readonly teamId?: { mode: "id" | "list" | "url"; value: string }

Select the team from the list, by URL, or by ID (the ID is the "groupId" parameter in the URL you get from "Get a link to the team") Default: {"mode":"list","value":""}

Source§

readonly title?: string

Title of the task

Source§

readonly updateFields?: {
    assignedTo?: { mode: "id" | "list"; value: string };
    bucketId?: { mode: "id" | "list"; value: string };
    dueDateTime?: string;
    groupId?: { mode: "id" | "list"; value: string };
    percentComplete?: number;
    planId?: { mode: "id" | "list"; value: string };
    title?: string;
}

Default: {}