Dokumentacja dla programistów

monday.execute

Aktualizacja 2025-10-23

Za pomocą monday.execute możesz wywołać działanie na nadrzędnym kliencie monday.

Parametry

Parametr	Opis
type	Działanie do wykonania
params	Opcjonalne parametry działania.

Działania

addDocBlock

Metoda addDocBlock dodaje nowy blok do dokumentu workdoc. Więcej informacji o blokach dokumentu znajdziesz w dokumentacji API.

Parametry

Zawartość każdego bloku definiuje obiekt JSON content, który zawiera wiele atrybutów, w tym deltaFormat. Aby tworzyć nowe bloki, musisz znać format Delta. Do formatowania zawartości zalecamy używanie biblioteki Delta Quill.

Przykład

const addToDoc = () => {
    const { focusedBlocks } = context;
    const afterBlockId = focusedBlocks[0].id;
    const data = {
      type: "normal text",
      content: {
        deltaFormat: [
          {
            insert: newText
          }
        ]
      },
      afterBlockId
    };


    monday.execute("addDocBlock", data);
    monday.execute("closeDocModal");
  };

addMultiBlocks

Metoda addMultiBlocks dodaje wiele bloków do dokumentu workdoc. Więcej informacji o blokach dokumentu znajdziesz w dokumentacji API.

Parametry

Zawartość każdego bloku definiuje obiekt JSON content, który zawiera wiele atrybutów, w tym deltaFormat. Aby tworzyć i aktualizować bloki, musisz znać format Delta. Do formatowania zawartości zalecamy używanie biblioteki Delta Quill.

Przykład

const contentForBlockOne = {
  deltaFormat: [
    {
      "alignment" : center
        "insert" : "Block one heading"
        "attributes" : {
            "bold" : true
    }
  ]
};

const contentForBlockTwo = {
  deltaFormat: [
    {
      "alignment" : left
      "insert" : "Block two heading",
      "attributes" : {
        "underline" : true
      }
    }
  ]
};

monday.execute("addMultiBlocks", {
  afterBlockId: "7f8c145-989f-48bb-b7f8-dc8f91690g42",
  blocks: [
    {
      type: "large title",
      content: contentForBlockOne
    },
    {
      type: "medium title",
      content: contentForBlockTwo
    }
  ]
})

addMultiBlocksFromHtml

Metoda addMultiBlocksFromHtml dodaje wiele bloków na początku dokumentu workdoc, używając kodu HTML. Jest dostępna wyłącznie w funkcji AI doc quickstart.

Parametry

Parametr	Typ	Opis	Wymagany
html	element HTML jako ciąg znaków	Elementy HTML, które mają zostać dodane do bloków.	Tak

Przykład

const html = '<h1>Marketing Brief</h1>\n<h2>Campaign purpose</h2>\n<span>List a purpose</span></html>';

monday.execute("addMultiBlocksFromHtml", {html: html}).then((res) => {});

attachExtensionsToColumn

Metoda attachExtensionsToColumn przypisuje funkcję aplikacji rozszerzenia kolumny tablicy do kolumny.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("attachExtensionsToColumn");

closeAppFeatureModal

Metoda closeAppFeatureModal zamyka okno modalne.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("closeAppFeatureModal").then((res) => {
  console.log(res.data);
});

closeDialog

Metoda closeDialog zamyka okno dialogowe asystenta AI.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("closeDialog");

closeDocModal

Metoda closeDocModal zamyka okno modalne bloku dokumentu. Jeśli nie wywołasz tej metody, okno zamknie się po kliknięciu poza nim.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("closeDocModal");

closeSettings

Metoda closeSettings zamyka okno ustawień widoku.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("closeSettings").then((res) => {
  console.log(res.data);
  // note that method will close view settings, unless settings were already closed
});

confirm

Metoda confirm otwiera okno dialogowe z prośbą o potwierdzenie.

Parametry

Parametr	Typ	Opis	Wymagany	Wartość domyślna
message	String	Wiadomość wyświetlana w oknie dialogowym.	Tak
confirmButton	String	Tekst przycisku potwierdzenia.	Nie	"OK"
cancelButton	String	Tekst przycisku anulowania.	Nie	"Cancel"
excludeCancelButton	Boolean	Określa, czy ukryć przycisk anulowania.	Nie	false

Przykład

monday.execute("confirm", {
   message: "Are you sure?",
   confirmButton: "Let's go!",
   cancelButton: "No way",
   excludeCancelButton: false
}).then((res) => {
    console.log(res.data);
    // {"confirm": true}
});

Tak będzie wyglądać okno dialogowe z prośbą o potwierdzenie:

detachExtensionsToColumn

Metoda detachExtensionsToColumn odłącza od kolumny funkcję aplikacji rozszerzenia kolumny tablicy.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("detachExtensionsToColumn");

moveToNextSelectedTextualBlock

Metoda moveToNextSelectedTextualBlock otwiera aplikację na następnym bloku, gdy zaznaczono kilka bloków. Jest dostępna wyłącznie po wywołaniu funkcji openAppOnFirstTextualBlock i służy tylko do obsługi funkcji AI doc command.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("moveToNextSelectedTextualBlock").then((res) => {});

moveToPrevSelectedTextualBlock

Metoda moveToPrevSelectedTextualBlock otwiera aplikację na poprzednim bloku, gdy zaznaczono kilka bloków. Jest dostępna wyłącznie po wywołaniu funkcji openAppOnFirstTextualBlock i służy tylko do obsługi funkcji AI doc command.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("moveToPrevSelectedTextualBlock").then((res) => {});

notice

Metoda notice wyświetla wiadomość u góry strony użytkownika. Przydaje się do wyświetlania komunikatów o powodzeniu, błędach i innych informacji.

Parametry

Parametr	Typ	Opis	Wymagany	Wartość domyślna
message	String	Wyświetlana wiadomość.	Tak
type	String	Typ wyświetlanej wiadomości. Może mieć wartość "success" (zielona), "error" (czerwona) lub "info" (niebieska).	Nie	"info"
timeout	Integer	Czas wyświetlania wiadomości w milisekundach.	Nie	5000

Przykład

monday.execute("notice", {
   message: "I'm a success message",
   type: "success", // or "error" (red), or "info" (blue)
   timeout: 10000,
});

Tak będzie wyglądać komunikat o powodzeniu:

openAppFeatureModal

Metoda openAppFeatureModal otwiera okno modalne jako element iFrame wskazujący wybraną witrynę. Możesz wyświetlić w nim stronę swojej aplikacji, przekazując argument urlPath lub urlParams. Możesz też wyświetlić zewnętrzną witrynę za pomocą argumentu url, na przykład stronę dokumentacji w swojej witrynie.

Parametry

Parametr	Typ	Opis	Wymagany	Wartość domyślna
url	String	Adres URL strony wyświetlanej w oknie modalnym.	Nie
urlPath	String	Podkatalog lub ścieżka adresu URL, który ma zostać otwarty. Przekaż względny adres URL, a nie bezwzględny.	Nie
urlParams	Object	Parametry zapytania adresu URL.	Nie
width	String	Szerokość okna modalnego.	Nie	"0px"
height	String	Wysokość okna modalnego.	Nie	"0px"
returnToPreviousModal	Boolean	Jeśli otwierasz okno modalne z poziomu innego okna modalnego, ustaw ten parametr na `true`, aby po zamknięciu zagnieżdżonego okna wrócić do pierwotnego.	Nie

Przykład

monday.execute("openAppFeatureModal", {
  urlPath: "/settings/profile",
  urlParams: { tab: "notifications" },
  width: "600px",
  height: "400px",
  returnToPreviousModal: true
}).then((res) => {
  // only triggered when a user closes the dialog
  console.log('Dialog closed. ', res.data);
  // note that `res.data.closed` is always true
});

Tak wygląda otwieranie i zamykanie okna modalnego:

openAppOnFirstTextualSelectedBlock

Metoda openAppOnFirstTextualSelectedBlock otwiera okno modalne aplikacji na pierwszym zaznaczonym bloku, gdy zaznaczono kilka bloków. Jest dostępna wyłącznie w funkcji AI doc toolbar.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("openAppOnFirstTextualSelectedBlock").then((res) => {});

openAppRatingPopup

Metoda openAppRatingPopup otwiera okno dialogowe, w którym użytkownicy mogą ocenić aplikację z marketplace. Możesz wywołać tę metodę raz na 24 godziny dla każdego użytkownika i tylko w elementach iFrame aplikacji z marketplace. Nie można jej wywołać dla użytkownika, który już ocenił aplikację.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute('openAppRatingPopup');

openCreateItemDialog

Metoda openCreateItemDialog otwiera okno modalne, w którym możesz utworzyć nowy element na określonej tablicy. Metoda przyjmuje dwa parametry, ale zalecamy używanie tylko jednego naraz albo żadnego.

Parametry

Parametr	Typ	Opis	Wymagany
boardId	Integer	Identyfikator tablicy, na której ma zostać utworzony element. Jeśli go pominiesz, element zostanie utworzony na bieżącej tablicy (na podstawie kontekstu).	Nie
boardIds	Lista liczb całkowitych	Identyfikatory tablic, na których użytkownik może wybrać tablicę do utworzenia elementu. Pierwszy podany identyfikator tablicy będzie zaznaczony domyślnie.	Nie

Przykład z boardId

monday.execute("openCreateItemDialog", {boardId:1234567890});

Przykład z boardIds

monday.execute("openCreateItemDialog", {boardIds:[1234567890,0987654321]});

openFilesDialog

Metoda openFilesDialog otwiera okno modalne z podglądem zasobu.

Parametry

Parametr	Typ	Opis	Wymagany
boardId	Integer	Identyfikator tablicy.	Tak
itemId	Integer	Identyfikator elementu zawierającego zasób.	Tak
columnId	String	Identyfikator kolumny zawierającej zasób.	Tak
assetId	Integer	Identyfikator zasobu do otwarcia.	Tak

Przykład

monday.execute("openFilesDialog", {
  boardId: 12345,
  itemId: 23456,
  columnId: 'files',
  assetId: 34567
})

openItemCard

Metoda openItemCard otwiera okno modalne z informacjami o wybranym elemencie. Użytkownicy mogą też dodać aktualizację lub usunąć element z poziomu tego okna.

Parametry

Parametr	Typ	Opis	Wymagany	Wartość domyślna
itemId	Integer	Identyfikator elementu do otwarcia.	Tak
kind	String	Widok, w którym ma się otworzyć karta elementu - może mieć wartość "updates" / "columns".	Nie	"columns"

Przykład

monday.execute("openItemCard", { itemId: item.id });

Tak będzie wyglądać otwarta karta elementu:

openLinkInTab

Metoda openLinkInTab otwiera link w nowej karcie dla widoków, takich jak widoki tablicy czy elementu.

Parametry

Parametr	Typ	Opis	Wymagany
url	String	Adres URL, który chcesz otworzyć w nowej karcie.	Tak

Przykład

monday.execute("openLinkInTab", { url: "https://www.exampleurl.com" });

openPlanSelection

Metoda openPlanSelection otwiera stronę wyboru planu lub kartę rozliczeń, aby użytkownicy mogli przejść na wyższy plan lub zapłacić za aplikację. Nie można jej przetestować. Działa wyłącznie w opublikowanych aplikacjach z marketplace.

Po otwarciu karty użytkownicy mogą zmienić subskrypcję: wykupić ją, przejść na wyższy lub niższy plan albo ją anulować. Mogą na przykład chcieć skorzystać z funkcji, której nie obejmuje ich plan. Możesz wtedy wyświetlić kartę rozliczeń, aby mogli przejść na kolejny plan.

Parametry

Parametr	Typ	Opis	Wymagany
isInPlanSelection	Boolean	Jeśli ma wartość `true`, otworzy się strona wyboru planu. To ustawienie domyślne. Użyj go, jeśli użytkownik ma najpierw zapłacić za aplikację. Jeśli ma wartość `false`, otworzy się sekcja rozliczeń aplikacji.	Nie
selectedPlanId	String	Identyfikator planu, który ma zostać wyświetlony na stronie. Jeśli używasz tego parametru, `isInPlanSelection` musi mieć wartość `true`.	Nie

Przykład

monday.execute('openPlanSelection', {isInPlanSelection: true, selectedPlanId: "123456"});

openSettings

Metoda openSettings otwiera okno ustawień widoku.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("openSettings").then((res) => {
  console.log(res.data);
  // note that method will open view settings, unless settings were already opened
});

Tak wygląda otwieranie i zamykanie ustawień:

replaceHighlightText

Metoda replaceHighlightText zastępuje zaznaczony tekst wybranym tekstem na początku bloku. Jest dostępna wyłącznie w funkcji AI doc command.

Parametry

Parametr	Typ	Opis	Wymagany
text	String	Tekst, który ma zostać wstawiony do bloku.	Tak

Przykład

monday.execute("replaceHighlightText", { text: "This will replace the highlted text" });

triggerFilesUpload

Metoda triggerFilesUpload otwiera okno modalne, w którym bieżący użytkownik może przesłać plik do określonej kolumny plików. Zwraca obietnicę. W przypadku błędu obietnica zostaje odrzucona.

Wymagany zakres uprawnień: boards:write

Po pomyślnym przesłaniu pliku zostanie wywołane zdarzenie change_column_value. Tutaj dowiesz się, jak subskrybować te zdarzenia.

Parametry

Parametr	Typ	Opis	Wymagany
boardId	Integer	Identyfikator tablicy.	Tak
itemId	Integer	Identyfikator elementu zawierającego zasób.	Tak
columnId	String	Identyfikator kolumny plików, do której ma zostać przesłany plik.	Tak

Przykład

monday.execute("triggerFilesUpload", {
  boardId: 12345,
  itemId: 23456,
  columnId: 'files'
})

updateDocBlock

Metoda updateDocBlock aktualizuje zawartość bloku. Więcej informacji o blokach dokumentu znajdziesz w naszej dokumentacji API.

Parametry

Przykład

const updateBlock = async () => {
    const { focusedBlocks, placement } = context;
    const { id } = focusedBlocks[0];
    const content = {
      deltaFormat: [
        {
          insert: "this is a random text"
        }
      ]
    };

    const res = await monday.execute("updateDocBlock", { id, content });
    await monday.execute("closeDocModal");

  };

updatePostContentAction

Metoda updatePostContentAction tworzy lub zmienia treść aktualizacji elementu. Jest dostępna wyłącznie w funkcji AI update.

Parametry

Parametr	Typ	Opis	Wymagany
suggestedRephrase	String	Treść, którą chcesz dodać do aktualizacji.	Tak

Przykład

monday.execute("updatePostContentAction", { suggestedRephrase: "Some text"})

valueCreatedForUser

Metoda valueCreatedForUser informuje platformę monday, że użytkownik uzyskał pierwszą wartość w aplikacji. Więcej informacji o tej metodzie znajdziesz w naszej dokumentacji.

Parametry

Ta metoda nie przyjmuje żadnych parametrów.

Przykład

monday.execute("valueCreatedForUser");

📘 Dołącz do naszej społeczności deweloperów!

Stworzyliśmy społeczność dla deweloperów, w której możesz wyszukiwać wcześniejsze dyskusje, by znaleźć rozwiązania, zadawać pytania, poznawać nowe funkcje i aktualizacje oraz odkrywać wskazówki i porady od innych deweloperów. Dołącz do nas! 😎

Mam problem z tym tematem Źródło: developer.monday.com