ParticipantItem

ParticipantItem クラスはスケジュールアプリの参加者型項目に対して操作を行うためのメンバーを持っています。

継承

SheetItem

インスタンスプロパティ

selectionNames

参加者の名前を示す文字列の配列です。

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames); // ["佐々木","佐藤"]
});

インスタンスメソッド

statusIsReset

強制的に参加者を出席にするかどうかを返します。 登録変更でのみ使用可能です。

構文

statusIsReset();

引数

なし

返値

真偽値

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.statusIsReset()); // true
});

setStatusReset

強制的に参加者を出席にするかを指定します。 変更画面のみ利用可能です。

構文

setStatusReset(boolean);

引数

boolean

強制的に参加者を出席にするかどうかを示す真偽値です。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.statusIsReset()); // true

  participantItem.setStatusReset(false);

  console.log(participantItem.statusIsReset()); // false
});

selectionsInclude

指定したステータスに指定した id の参加者が存在するか判定します。

構文

selectionsInclude(id, state);

引数

id

参加者の id を示す数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionsInclude(1)); // true
});

setStatusResetCheckboxDisabled

参加者のステータスをリセットするチェックボックスを使用可否を変更します。 変更画面のみ利用可能です。

構文

setStatusResetCheckboxDisabled(disabled);

引数

disabled

参加者のステータスをリセットするチェックボックスの使用可否を示す真偽値です。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  participantItem.setStatusResetCheckboxDisabled(true);
});

isForcedToParticipate

強制的に参加者を出席にするかどうかを返します。

構文

isForcedToParticipate(includingAbsentees);

引数

includingAbsentees

欠席者を含むか含まないかの真偽値です。includingAbsentees を渡すと欠席者を含むか含まないかも判定します。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.isForcedToParticipate(true)); // true
});

setForcedToParticipate

強制的に参加者を出席にするかどうかを指定します。 登録変更でのみ使用可能です。

構文

setForcedToParticipate(v, includingAbsentees);

引数

v

強制的に参加者を出席にするかどうかの真偽値です。

includingAbsentees

欠席者を含むかどうかの真偽値です。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  participantItem.setForcedToParticipate(true, false);

  console.log(participantItem.isForcedToParticipate(true)); // false

  console.log(participantItem.isForcedToParticipate(false)); // true
});

setForceParticipationCheckboxDisabled

参加者を出席にするチェックボックスの使用可否を変更します。 登録変更のみ使用可能です。

構文

setForceParticipationCheckboxDisabled(disabled);

引数

disabled

参加者を出席にするチェックボックスの使用可否を示す真偽値です。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  participantItem.setForceParticipationCheckboxDisabled(true);
});

setIncludingAbsenteesRadioDisabled

欠席者を含むかどうかのラジオボタンの使用可否を変更します。 変更画面のみ利用可能です。

構文

setIncludingAbsenteesRadioDisabled(disabled);

引数

disabled

欠席者を含むかどうかのチェックボックスの使用可否を示す真偽値です。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  participantItem.setIncludingAbsenteesRadioDisabled(true);
});

selectionLengthEqualsTo

指定したステータスに指定した数と同じ参加者数かどうかを判定します。

構文

selectionLengthEqualsTo(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames); // ["佐藤","佐々木"]

  console.log(participantItem.selectionLengthEqualsTo(2)); //true
});

selectionLengthIsGreaterThan

指定したステータスの参加者数が指定した数よりも多いかどうかを判定します。

構文

selectionLengthGreaterThan(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames); // ["佐藤","佐々木"]

  console.log(participantItem.selectionLengthIsGreaterThan(1)); //true
});

selectionLengthIsGreaterThanOrEqual

指定したステータスの参加者数が指定した数以上であるかどうかを判定します。

構文

selectionLengthGreaterThanOrEqual(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames); // ["佐藤","佐々木"]

  console.log(participantItem.selectionLengthIsGreaterThanOrEqual(1)); //true
});

selectionLengthIsLessThan

指定したステータスの参加者数が指定した数よりも少ないかどうかを判定します。

構文

selectionLengthIsLessThan(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames); // ["佐藤","佐々木"]

  console.log(participantItem.selectionLengthIsLessThan(8)); //true
});

selectionLengthIsLessThanOrEqual

指定したステータスの参加者数が指定した数以下であるかどうかを判定します。

構文

selectionLengthIsLessThanOrEqual(length, state);

引数

length

比較対象の数値です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全範囲の検索になります。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames); // ["佐藤","佐々木"]

  console.log(participantItem.selectionLengthIsLessThanOrEqual(8)); //true
});

onSetToResetStatus

参加者の出欠をリセットした後に呼び出されるeventHookを登録します。 変更画面のみ利用可能です。

構文

onSetToResetStatus(callback);
onSetToResetStatus(callback, group);

引数

callback

参加者の出欠をリセットした後に呼び出されて実行する関数です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const participantItem = screen.getSheetItemByLabel("参加者");

  const unlisten = participantItem.onSetToResetStatus(function () {
    console.log("SetToResetStatus");
    unlisten(); // 解除
  });
});

onUnsetToResetStatus

参加者の出欠をリセットした後に呼び出されるeventHookを登録します。 変更画面のみ利用可能です。

構文

onUnsetToResetStatus(callback);
onUnsetToResetStatus(callback, group);

引数

callback

参加者の出欠をリセットを解除した後に呼び出されて実行する関数です。 変更のみ利用可能です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const participantItem = screen.getSheetItemByLabel("参加者");

  const unlisten = participantItem.onUnsetToResetStatus(function () {
    console.log("UnsetToResetStatus");
    unlisten(); // 解除
  });
});

onSetForcedToParticipate

指定した参加者を強制的に出席した後に呼び出されるeventHookを登録します。 登録変更のみ利用可能です。

構文

onSetForcedToParticipate(callback);
onSetForcedToParticipate(callback, includingAbsentees);
onSetForcedToParticipate(callback, includingAbsentees, group);

引数

callback

指定した参加者を強制的に出席した後に呼び出されて実行する関数です。

includingAbsentees

欠席者を含むか含まないかの真偽値です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const participantItem = screen.getSheetItemByLabel("参加者");

  const unlisten = participantItem.onSetForcedToParticipate(function () {
    console.log("SetForcedToParticipate");
    unlisten(); // 解除
  });
});

onUnsetForcedToParticipate

参加者を強制的に出席しないようにした後に呼び出されるeventHookを登録します。 登録変更のみ利用可能です。

構文

onUnsetForcedToParticipate(callback);
onUnsetForcedToParticipate(callback, group);

引数

callback

参加者を強制的に出席しないようにした後に呼び出されて実行する関数です。 登録変更でのみ使用可能です。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const participantItem = screen.getSheetItemByLabel("参加者");

  const unlisten = participantItem.onUnsetForcedToParticipate(function () {
    console.log("UnsetForcedToParticipate");
    unlisten(); // 解除
  });
});

onSelectionAdded

指定したステータスの参加者が追加された後に呼び出されるeventHookを登録します。

構文

onSelectionAdded(callback, state, group);

引数

callback

参加者が追加されたタイミングで実行する関数です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const participantItem = screen.getSheetItemByLabel("参加者");

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

onSelectionRemoved

指定したステータスの参加者が削除された後に呼び出されるeventHookを登録します。

構文

onSelectionAdded(callback, state, group);

引数

callback

参加者が削除されたタイミングで実行する関数です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const participantItem = screen.getSheetItemByLabel("参加者");

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

onSelectionsUpdated

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

構文

onSelectionsUpdated(callback, state, group);

引数

callback

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

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。

group

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

返値

なし

例

esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
  const participantItem = screen.getSheetItemByLabel("参加者");

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

setSelectionAdded

指定したステータスについてidを指定して参加者を追加します。

構文

setSelectionAdded(id, state);

引数

id

参加者の id を示す文字列です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、参加者に追加されます。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames.length); // 2

  participantItem.setSelectionAdded(1);

  console.log(participantItem.selectionNames.length); // 3
});

setSelectionRemoved

指定したステータスについてidを指定して参加者を削除します。

構文

setSelectionRemoved(id, state);

引数

id

参加者の id を示す文字列です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、参加者にから削除されます。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames.length); // 2

  participantItem.setSelectionRemoved(1);

  console.log(participantItem.selectionNames.length); // 1
});

setSelectionsEmpty

指定したステータスの参加者をすべて削除します。

構文

setSelectionsEmpty(id, state);

引数

id

参加者の id を示す文字列です。

state

参加者のステータスです。 attended,absent,share,unconfirming から選択してください。指定がない場合、全て削除されます。

返値

真偽値

例

esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((SheetSaveScreen) => {
  const participantItem = SheetSaveScreen.getSheetItemByLabel("参加者");

  console.log(participantItem.selectionNames.length); // 2

  participantItem.setSelectionsEmpty();

  console.log(participantItem.selectionNames.length); // 0
});

関連情報