IntervieweeItem

IntervieweeItemクラスは活動シート、タスクシートの当日面談者項目に対しての操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

selectionNames

紐づいている各名刺の名前の配列です。

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  IntervieweeItem.onSelectionsResolved(function() {

    console.log("紐づいている名刺の名前の配列", IntervieweeItem.selectionNames); // 紐づいている名刺の名前の配列: "[高橋, 佐藤, 近藤, 斎藤]"
    
  });
});

selectionsLength

紐づいている名刺の数を表す数値です。

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  IntervieweeItem.onSelectionsResolved(function() {

  console.log("紐づいている名刺の名前の配列", IntervieweeItem.selectionNames); // 紐づいている名刺の名前の配列: "[高橋, 佐藤, 近藤, 斎藤]"

  console.log("紐づいている名刺の数：", IntervieweeItem.selectionsLength); // 紐づいている名刺の数：４

  });
});

text

入力されている文字列です。

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  // 値を変更
  intervieweeItem.text = "資料を作成します";

  // 変更後の値を確認ss
  console.log("変更後:", intervieweeItem.text); // 変更後: "資料を作成します"
});

textLength読み取り専用

text の文字数を表します。

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  console.log("文字数:", intervieweeItem.textLength); // 文字数: 7
});

インスタンスメソッド

setText

文字列を受け取り、入力内容を変更します。

構文

setText(text);

引数

text
入力内容を示す文字列です。

返値

なし

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  // 値を変更
  intervieweeItem.setText("資料を作成します");

  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.text); // 変更後: "資料を作成します"
});

onTextUpdated

textが更新された後に呼び出されるeventHookを登録します。

構文

onTextUpdated(callback);
onTextUpdated(callback, group);

引数

callback

textが更新されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // entitiesが初期化されたタイミングで関数を実行
  const unlisten = intervieweeItem.onTextUpdated(function () {
    console.log("TextUpdated");
    unlisten(); // 解除
  });
});

textLengthEqualsTo

数値を受け取り、text の文字数が指定した数値と同じかどうかの真偽値を返します。

構文

textLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  const result = intervieweeItem.textLengthEqualsTo(7);

  console.log("文字数が7かどうか:", result); // 文字数が7どうか: true
});

textLengthIsGreaterThan

text の文字数が指定した数値より大きいかどうかを判定します。

構文

textLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  const result = intervieweeItem.textLengthIsGreaterThan(6);

  console.log("文字数が6より大きいか:", result); // 文字数が6より大きいか: true
});

textLengthIsGreaterThanOrEqual

text の文字数が指定した数値以上かどうかを判定します。

構文

textLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  const result = intervieweeItem.textLengthIsGreaterThanOrEqual(8);

  console.log("文字数が8以上か:", result); // 文字数が8以上か: false
});

textLengthIsLessThan

text の文字数が指定した数値より小さいかどうかを判定します。

構文

textLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  const result = intervieweeItem.textLengthIsLessThan(10);

  console.log("文字数が10未満か:", result); // 文字数が10未満か: true
});

textLengthIsLessThanOrEqual

text の文字数が指定した数値以下かどうかを判定します。

構文

textLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  const result = intervieweeItem.textLengthIsLessThanOrEqual(8);

  console.log("文字数が8以下か:", result); // 文字数が8以下か: true
});

textContains

指定した文字列が text に含まれているかどうかを判定します。

構文

textContains(substring);

引数

substring
検索対象の文字列です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  const containsBrain = intervieweeItem.textContains("ブレイン");
  console.log("「ブレイン」が含まれるか:", containsBrain); // 「ブレイン」が含まれるか: false
});

textEqualsTo

text が指定した文字列と一致するかどうかを判定します。

構文

textEqualsTo(string);

引数

string
比較対象の文字列です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.text); // 初期値: "資料を作成する"

  const isEqual = intervieweeItem.textEqualsTo("資料を作成する");
  console.log("「資料を作成する」と一致するか:", isEqual); // 「資料を作成する」と一致するか: true
});

selectionsInclude

id を示す数値を受け取り、紐づいている名刺に指定した id が含まれているかどうかの真偽値を返します。

構文

selectionsInclude(id);

引数

id
名刺の ID を示す数値です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_suggest2"
  );

  console.log(
    "selections:",
    intervieweeItem.selections
      .getRows()
      .entries.map((selection) => selection.selectionId)
  ); // selections: [1,2,3,4,5]

  const result = IntervieweeItem.selectionsInclude(1);

  console.log("結果:", result); // 結果: true
});

selectionNamesInclude

文字列を受け取り、紐づいている名刺名に指定した文字列が含まれているかどうかの真偽値を返します。

構文

selectionsInclude(name);

引数

name
名刺の名前を示す文字列です。

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_suggest2"
  );
  IntervieweeItem.onSelectionsResolved(function() {

  console.log(intervieweeItem.selectionNames); // selections: ["佐藤","鈴木"]

  const result = IntervieweeItem.selectionsInclude("佐藤");

  console.log("結果:", result); // 結果: true

  });
});

includesNonReferableSelection

紐づいている名刺に閲覧権限のない名刺が含まれているかどうかを判定します。

構文

includesNonReferableSelection();

引数

なし

返値

真偽値

例

esmJSPlugin.sheetSave("activity").onSheetItemsMounted((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItem(
    "customers.customer.type_suggest2"
  );

  console.log(
    "selections:",
    intervieweeItem.selections
      .getRows()
      .entries.map((selection) => selection.selectionId)
  ); // selections: [1,2,NaN,4,5]

  const result = IntervieweeItem.includesNonReferableSelection();

  console.log("結果:", result); // 結果: true
});

onSelectionAdded

紐づいている名刺が追加された後に呼び出されるeventHookを登録します。

構文

onSelectionAdded(callback);
onSelectionAdded(callback, group);

引数

callback

紐づいている名刺が追加されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  const unlisten = intervieweeItem.onSelectionAdded(function () {
    console.log("SelectionAdded");
    unlisten(); // 解除
  });
});

onSelectionRemoved

紐づいている名刺が削除された後に呼び出されるeventHookを登録します。

構文

onSelectionRemoved(callback);
onSelectionRemoved(callback, group);

引数

callback

紐づいている名刺が削除されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  const unlisten = intervieweeItem.onSelectionRemoved(function () {
    console.log("SelectionRemoved");
    unlisten(); // 解除
  });
});

onSelectionsUpdated

紐づいている名刺が更新された後に呼び出されるeventHookを登録します。

構文

onSelectionsUpdated(callback);
onSelectionsUpdated(callback, group);

引数

callback

紐づいている名刺が更新されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // entitiesが初期化されたタイミングで関数を実行
  const unlisten = intervieweeItem.onSelectionsUpdated(function () {
    console.log("SelectionsUpdated");
    unlisten(); // 解除
  });
});

onSelectionsResolved

紐づいている名刺のデータが解決された後に呼び出されるeventHookを登録します。

構文

onSelectionsResolved(callback);
onSelectionsResolved(callback, group);

引数

callback

紐づいている名刺のデータが解決されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // entitiesが初期化されたタイミングで関数を実行
  const unlisten = intervieweeItem.onSelectionsResolved(function () {
    console.log("SelectionsResolved");
    unlisten(); // 解除
  });
});

getSelections

Selectionsクラスのインスタンスを返します。

構文

getSelections();

引数

なし

返値

Selectionsクラスのインスタンス

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  const selections = intervieweeItem.getSelections()

  console.log(selections);

});

getSelectionBy

指定した ID のSelectionクラスのインスタンスを返します。

構文

getSelectionBy(ID);

引数

ID

紐づいている名刺の ID を示す数値です。

返値

Selectionクラスのインスタンス

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  const Selection = intervieweeItem.getSelectionBy(1);

  console.log(Selection.entityId);
  // 1
});

getSelectionByIndex

指定した行のSelectionクラスのインスタンスを返します。

構文

getSelectionByIndex(index);

引数

index

紐づいている名刺が何行目かを示す数値です。

返値

Selectionクラスのインスタンス

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  const Selection = intervieweeItem.getSelectionByIndex(1);

  console.log(Selection.entityId);
  // 1
});

setSelectionsEmpty

紐づいている名刺を全て削除します。

構文

setSelectionsEmpty();

引数

なし

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  console.log(intervieweeItem.selectionsLength);
  // 3

  intervieweeItem.setSelectionsEmpty();

  console.log(intervieweeItem.selectionsLength);
  // 0
});

setSelectionAdded

entityId を指定して、紐づいている名刺を追加します。

構文

setSelectionAdded(entityId);

引数

entityId

紐づいている名刺の entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  console.log(intervieweeItem.selectionsLength);
  // 3

  intervieweeItem.setSelectionAdded(1);

  console.log(intervieweeItem.selectionsLength);
  // 4
});

setSelectionRemoved

指定した entityId の紐づいている名刺を削除します。

構文

setSelectionAdded(entityId);

引数

entityId

紐づいている名刺の entityId を示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  console.log(intervieweeItem.selectionsLength);
  // 3

  intervieweeItem.setSelectionRemoved(1);

  console.log(intervieweeItem.selectionsLength);
  // 2
});

setSelectionRemovedByIndex

指定した index の紐づいている名刺を削除します。

構文

setSelectionRemovedByIndex(index);

引数

index

何行目の紐づいている名刺かを示す数値です。

返値

なし

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  console.log(intervieweeItem.selectionsLength);
  // 3

  intervieweeItem.setSelectionRemoved(1);

  console.log(intervieweeItem.selectionsLength);
  // 2
});

selectionsLengthEqualsTo

selectionsLengthが指定した数値と同じかどうかを判定します。

構文

selectionsLengthEqualsTo(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.onUpdated(function () {
    // 値を確認
    console.log("値:", intervieweeItem.selectionsLength); // 値: 7

    const result = intervieweeItem.selectionsLengthEqualsTo(7);

    console.log("文字数が7かどうか:", result); // 文字数が7かどうか: true
  });
});

selectionsLengthIsGreaterThan

selectionsLengthが指定した数値より大きいかどうかを判定します。

構文

selectionsLengthIsGreaterThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.onUpdated(function () {
    // 値を確認
    console.log("値:", intervieweeItem.selectionsLength); // 値: 7

    const result = intervieweeItem.selectionsLengthIsGreaterThan(6);

    console.log("6より大きいか:", result); // 6より大きいか: true
  });
});

selectionsLengthIsGreaterThanOrEqual

selectionsLengthが指定した数値以上かどうかを判定します。

構文

selectionsLengthIsGreaterThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.onUpdated(function () {
    // 値を確認
    console.log("値:", intervieweeItem.selectionsLength); // 値: 7

    const result = intervieweeItem.selectionsLengthIsGreaterThanOrEqual(6);

    console.log("6以上か:", result); // 6以上か: true
  });
});

selectionsLengthIsLessThan

selectionsLengthが指定した数値より小さいかどうかを判定します。

構文

selectionsLengthIsLessThan(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.onUpdated(function () {
    // 値を確認
    console.log("値:", intervieweeItem.selectionsLength); // 値: 7

    const result = intervieweeItem.selectionsLengthIsLessThan(10);

    console.log("10未満か:", result); // 10未満か: true
  });
});

selectionsLengthIsLessThanOrEqual

selectionsLengthが指定した数値以下かどうかを判定します。

構文

selectionsLengthIsLessThanOrEqual(number);

引数

number
比較対象の数値です。

返値

真偽値

例

esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.onUpdated(function () {
    // 値を確認
    console.log("値:", intervieweeItem.selectionsLength); // 値: 7

    const result = intervieweeItem.selectionsLengthIsLessThanOrEqual(8);

    console.log("8以下か:", result); // 8以下か: true
  });
});

関連情報

• SheetItem
• Selections
• Selection