ビルトイン関数

アクションには最初から用意されている関数があります。これをビルトイン関数と呼びます。 ビルトイン関数はオブジェクト$fnのメソッドに該当し$fn.XXXの形式で呼び出すことができます。

Tips

Tips

ビルトイン関数の中には非同期関数があります。非同期関数コール時は結果が返されるまで処理を待機するため、await式を用いる必要があります。エラー発生時は catch節にて、Amazon SDKが返却するエラーオブジェクトを受け取ります。

$fn.addUsers(param)

アプリケーションの認可グループにユーザを追加します。[非同期]

Tips

Tips

• 非同期関数であるため、コール時にawait式が必要になります。
• グループへのユーザ登録は１回につき最大100人までにしてください。
  それ以上のユーザを指定した場合は、実行時にエラーが発生し、グループに所属しているユーザ数がずれる場合があります。 100人を超えるユーザをグループに登録する場合は、分割して登録をしてください。

引数

名前	型	説明
param	object	グループ名と追加するユーザ情報

param詳細

プロパティ	型	説明
groupName	string	グループ名
emails	array of string	グループに加えるユーザのメールアドレス配列

戻り値

なし

サンプル

try {
  /* CSV の内容
   * ---------------------------
   * "email"
   * "user01@test.co.jp"
   * "user02@test.co.jp"
   * ---------------------------
   */
    const file = await $fn.getFile('/addUsers.csv');
    const buffer = file.data;
    const addUsers = $fn.csvToObject(buffer);
    const emails = addUsers.map(function (item) {
        return item['email'];
    });
    // 認可グループ「Group01」にユーザ追加
    await $fn.addUsers({
        groupName: "Group01",
        emails: emails
    });
}catch(err) {
   console.log("Error", err);
}

$fn.createFolder(path)

指定パスにフォルダを作成します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
path	string	作成するフォルダのパス

Tips

Tips

[path]に既存のフォルダパスを指定した場合は処理は無視します。

戻り値

なし

サンプル

try {
    await $fn.createFolder('/folder1');
} catch (err) {
    console.log("Error", err);
}

$fn.createGroup(param)

アプリケーションの認可グループを追加します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
param	object	登録するグループ情報

param詳細

プロパティ	型	説明
groupName	string	グループ名
description	string	詳細

戻り値

型	説明
Promise<Group>	登録したグループ情報

オブジェクト	プロパティ	型	説明
Group	groupName	string	グループ名
	description	string	説明
	members	object array	グループに所属するアクティブユーザ配列

Tips

Tips

エラー時は下記のキーを持つエラーオブジェクトを戻り値として返します。

• errorType
• errorMessage
• trace

サンプル

const groupName = $ui.groupName.value;
const description = $ui.description.value;
try {
    await $fn.createGroup({
        groupName: groupName,
        description: description
     });
} catch (err) {
    console.log("Error", err);
}

$fn.createUser(param)

アプリケーションの認証ユーザを追加します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
param	object	登録するユーザ情報

param詳細

プロパティ	型	説明
email	string	Eメール（サインインIDに使用する文字列）
name	string	名前
password	string	一時パスワード
sendMail	boolean	true：発行メール送信する false：発行メール送信しない デフォルトはfalse
custom_01	string	カスタム属性1
custom_02	string	カスタム属性2
custom_03	string	カスタム属性3
custom_04	string	カスタム属性4
custom_05	string	カスタム属性5
custom_06	string	カスタム属性6
custom_07	string	カスタム属性7
custom_08	string	カスタム属性8
custom_09	string	カスタム属性9
custom_10	string	カスタム属性10

Tips

Tips

Eメール、名前、一時パスワード、カスタム属性の最大文字数や制限については、ユーザの作成 ページを参照してください。

戻り値

型	説明
Promise<User>	登録したユーザ情報

オブジェクト	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	名前
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

Tips

Tips

エラー時は下記のキーを持つエラーオブジェクトを戻り値として返します。

• errorType
• errorMessage
• trace

サンプル

try {
  /* CSV の内容
   * ------------------------------------------------------
   * "email","name","password","sendMail"
   * "user01@test.co.jp","User01","Password@01",true
   * "user02@test.co.jp","User02","Password@02",false
   * ------------------------------------------------------
   */
     const file = await $fn.getFile('/userInfo.csv');
     const buffer = file.data;
     const userInfos = $fn.csvToObject(buffer);
     for (let userInfo of userInfos) {
         console.log(JSON.stringify(userInfo));
         let data = {};
         data = {
             email: userInfo['email'],
             name: userInfo['name'],
             password: userInfo['password'],
             sendMail: JSON.parse(userInfo['sendMail'])
         };
         // ユーザ追加
         let result=await $fn.createUser(data);
     if(result.errorType){
          throw new Error (result.errorMessage);
     }
    }
} catch(err) {
    console.log("Error", err.message);
}

$fn.csvToObject(csv)

指定したCSVファイルデータをオブジェクト形式に変換します。

引数

名前	型	説明
csv	Buffer	CSVファイルのBufferオブジェクト

CSVファイルの仕様

ヘッダ行	必須 オブジェクトのプロパティ名になります。 半角英数字のみ可能です。 (数字開始は不可) 例）“email”, “name”
区切り文字	,（カンマ）
フィールド	値にダブルクォーテーション、カンマ、改行を含む場合は、必ず囲ってください。
改行コード	CRLF または LF
文字コード	UTF-8
BOM	BOMなし または BOM付

戻り値

型	説明
array of object	CSVファイルデータをオブジェクト形式に変換して返却します

Tips

Tips

• CSVファイルのヘッダ名がオブジェクトのプロパティ名になります。
• オブジェクト形式に変換後の各値は、文字列で返却されます。
• CSVファイルの仕様に則っていない場合は、例外メッセージをthrowします。

サンプル

try {
  /* CSVの内容
   * -------------------------------------------------------------------
   * Id,Title,Description,Progress,Category,CreatedBy,CreatedAt
   * 00001,タイトル1,"説明1, サンプル1",100,CATEGORY1,User1,2023-08-01
   * 00002,タイトル2,"説明2, サンプル2",80,CATEGORY2,User2,2023-08-10
   * 00003,タイトル3,"説明3, サンプル3",20,CATEGORY3,User3,2023-08-12
   * -------------------------------------------------------------------
   */
  const file = await $fn.getFile("/path/to/projects.csv");
  const buffer = file.data;
  // CSVファイルをパースし、オブジェクトへ変換
  const projects = $fn.csvToObject(buffer);
  // 1件ずつデータを登録
  for (const project of projects) {
    const { Id, Title, Description, Category, Progress, CreatedBy, CreatedAt } = project;
    if (!Id) {
      throw new Error("IDが入力されていません。");
    }
    const progress = Number(Progress);
    if (isNaN(progress)) {
      throw new Error("進捗率は数値で入力して下さい。");
    }
  /* SQL 関数の内容
   * ------------------------------------------------------------------------------------
   * insert into Project VALUES  (${param.id},${param.title},${param.description},
   * ${param.progress},${param.category},${param.createdBy},${param.createdAt});
   * ------------------------------------------------------------------------------------
   */
    // SQL関数でテーブルにデータを登録
    await insertToProjectTable({
      id: Id,
      title: Title,
      description: Description,
      progress,
      category: Category,
      createdBy: CreatedBy,
      createdAt: CreatedAt
     });
  }
} catch (e) {
  console.error(e);
}

$fn.deleteFile(path)

指定パスにあるファイルを削除します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
path	string	削除するファイルのパス

Tips

Tips

[path]に空、undefined、nullを指定した場合、処理は無視します。

戻り値

なし

サンプル

try {
    await $fn.deleteFile('/note.txt');
 } catch (err) {
    console.log("Error", err);
 }

$fn.deleteFolder(path)

指定パスにあるフォルダを削除します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
path	string	削除するフォルダのパス

Tips

Tips

• [path]に / を指定した時は、ルートからすべてのファイル、フォルダが削除されます。
• [path]に空、undefined、nullを指定した場合、処理は無視します。

戻り値

なし

サンプル

try {
    await $fn.deleteFolder('/folder1');
} catch (err) {
    console.log("Error", err);
}

$fn.deleteUser(email)

アプリケーションの認証ユーザを削除します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
email	string	削除するユーザのEメール

戻り値

なし

Tips

Tips

エラー時は下記のキーを持つエラーオブジェクトを戻り値として返します。

• errorType
• errorMessage
• trace

サンプル

try {
  /* CSV の内容
   * ---------------------------
   * "email"
   * "user01@test.co.jp"
   * "user02@test.co.jp"
   * ---------------------------
   */
     const file = await $fn.getFile('/userInfo.csv');
     const buffer = file.data;
     const userInfos = $fn.csvToObject(buffer);
     const emails = userInfos.map(function (item) {
         return item['email'];
     });
     // ユーザ削除
     for (let email of emails) {
         console.log(email);
         await $fn.deleteUser(email);
      }
} catch(err) {
    console.log("Error", err);
}

$fn.download(file, filename)

指定したファイルをローカルにダウンロードします。ダウンロードするファイル名を指定することができます。 [非同期]

Tips

Tips

ブラウザ制限により、1アクションで1ファイルのみダウンロードすることができます。

引数

名前	型	説明
file	Buffer	ダウンロードするファイルのBufferオブジェクト
filename	string	ダウンロードするファイル名

戻り値

なし

サンプル

try {
  const file = await $fn.getFile('/note.json');
  const buffer = file.data;
  // File Download
  await $fn.download(buffer, 'download.json');
} catch (err) {
  console.log("Error", err);
}

$fn.getCurrentPosition()

スマートフォン端末の現在位置を取得します。

Tips

Tips

モバイルアプリケーションのアクションでのみ利用できます。

引数

なし

戻り値

型	説明
GeolocationCoordinates	デバイスの位置情報

サンプル

const position = $fn.getCurrentPosition();
const latitude = position.latitude;
const longitude = position.longitude;

$fn.getCurrentUser()

サインインしているユーザを取得します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

なし

戻り値

型	説明
User	サインイン中のユーザを返却します

オブジェクト	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	名前
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
    const user = await $fn.getCurrentUser();
    console.log(user);
} catch (err) {
    console.log("Error", err);
}

$fn.getFile(path)

指定パスのファイルを取得します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
path	string	取得するファイルのパス

Tips

Tips

[path]に空、undefined、nullを指定した場合、処理は無視します。

戻り値

型	説明
Promise<{data: Buffer}>	Amazon S3から取得するバイナリデータ(data:Buffer型)をプロパティに持つオブジェクト

Tips

Tips

ファイルがテキストで中身の文字列を取得したい場合は、Buffer#toString()を利用できます。

サンプル

try {
     const file = await $fn.getFile('/note.json');
     const buffer = file.data;
     // JSON object
     const obj = JSON.parse(buffer.toString());
 } catch (err) {
     console.log("Error", err);
 }

$fn.getFileNames(path)

指定ディレクトリパスにあるファイル名のリストを取得します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
path	string	取得するディレクトリのパス

戻り値

型	説明
array of string	ターゲットディレクトリ内のファイル名のリスト

サンプル

try {
    const files = await $fn.getFileNames('/folder1');
} catch (err) {
    console.log("Error", err);
}

$fn.getGroups(option)

ユーザマネージャに存在するすべてのグループを取得します。[非同期]

Tips

Tips

• 非同期関数であるため、コール時にawait式が必要になります。
• グループ名「Global」は取得できません。

引数

名前	型	説明
option	object	グループに所属するユーザを含めるか指定

option詳細

名前	型	説明
containUsers	boolean	true: グループに所属するユーザを含める false: グループに所属するユーザを含めない デフォルトはtrue

戻り値

型	説明
Promise<Group[]>	グループリスト

オブジェクト	プロパティ	型	説明
Group	groupName	string	グループ名
	description	string	説明
	members	object array	グループに所属するアクティブユーザ配列

サンプル

try {
    // グループに所属するユーザを含めないグループ情報を取得
    const groups = await $fn.getGroups({containUsers:false});
    console.log(groups);
} catch (err) {
    console.log("Error", err);
}

$fn.getLanguage()

現在表示している言語を取得します。

引数

なし

戻り値

型	説明
string	[default | en | ja] のいずれかの値を返します

サンプル

const lang = $fn.getLanguage();

$fn.getPresignedUrl(path,options)

WebPerformerNXの実行環境にあるファイルマネージャに対してアクセスするための署名付きURLの発行します。[非同期]

Tips

Tips

• プレミアム実行環境のみ使用可能な関数です。
• 非同期関数であるため、コール時にawait式が必要になります。
• アクセス権を与えたいファイルのパスを指定することで、そのファイルを指定有効時間、外部からアップロード/ダウンロード/削除することができます。
  • ファイルのアップロードは、最大5GBまでとなります。
  • 有効時間に制限はありませんが、セキュリティの観点から長時間有効にする設定は推奨していません。

引数

名前	型	説明
path	string	署名付きURLを発行するファイルマネージャのファイルパス 下記のクエリパラメータに対応 クエリパラメータ 説明 response-content-type レスポンスヘッダのContent-typeを上書き 指定なしの場合 binary/octet-stream が設定されます response-cache-control レスポンスヘッダのCache-controlを上書き
options	object	署名付きURLの有効時間

options詳細

プロパティ	型	説明
expiresIn	number	署名付きURLの有効時間（秒） デフォルトは900

Tips

Tips

• [path]プロパティで2種類のワイルドカードを指定することができます。
  • アスタリスク(*)：0個以上の文字に一致する
  • 疑問符(?)：1つの文字に一致する
• [path]プロパティにマルチバイトや特殊記号(#$&+,/:;=?@)を含む場合はエンコードが必要です。
  • マルチバイトを含むパスの場合は、encodeURI関数でパス全体をエンコードする必要があります。
  • パスに特殊記号を含む場合、特殊記号を含む部分を個別にencodeURIComponent関数でエンコードを行い、パスを結合してください。
• [path]プロパティに指定する文字の最大バイト数は988バイトです。
• フォルダにアクセス権を与える場合は、[path]プロパティには「/フォルダ名/*」のようにフォルダ配下にアクセス権を与えるようにワイルドカードを指定してください。
  • ワイルドカードを指定して発行した署名付きURLを使用する場合は、ワイルドカードの部分はファイル名に変更してください。
• [path]プロパティにクエリパラメータを含める場合は、? はバックスラッシュでエスケープ必要になります。
• [path]プロパティにresponse-content-typeを含める場合、MIMEタイプのスラッシュがエンコードされます。発行した署名付きURLは、スラッシュに戻してから使用してください。
• キャッシュを有効化しているブラウザでファイルダウンロードを行うと、有効時間外でディスクキャッシュからダウンロードされる場合があります。クエリパラメータを使用してキャッシュを保存しないようにしてください。

戻り値

型	説明
string	署名付きURL

サンプル

// ファイルパスにクエリパラメータ（キャッシュ:保存しない、MIMEタイプ:application/pdf）指定
const path = $ui.filePath.value + "\?response-cache-control=no-store&response-content-type=application/pdf";
// 有効時間10分の署名付きURLを発行
$ui.url.value = await $fn.getPresignedUrl(path, {expiresIn:600});

Tips

Tips

署名付きURLの有効期限について
有効期限切れ時刻の直前にクライアントが大きなファイルのダウンロードを開始した場合、ダウンロード中に有効期限切れ時刻が経過してもダウンロードは完了します。
TCP接続が中断し、有効期限切れ時刻が経過した後にクライアントがダウンロードを再開した場合、ダウンロードは失敗します。

Tips

Tips

署名付きURLを使用してファイルをアップロードする手順例
curlコマンドを実行して、ファイルをアップロードする例になります。

1. [path]プロパティにアクセスしたいフォルダ配下にアクセス権を与える署名付きURLを発行する。
   例：await $fn.getPresignedUrl(‘/My_Folder/*’, {expiresIn:600});

2. 手順1で発行したURLのワイルドカード部分(*)を、ファイルマネージャにアップロードするファイル名に変更する。
   例）アップロードするファイル名をsample.jpgとする https://<ドメイン>/<オーナーID>/My_Folder/sample.jpg?Policy=・・・

3. curl コマンドを実行して、ファイルをアップロードする。
   例：curl -X PUT —upload-file C:\temp\sample.jpg “手順2で更新した署名付きURL”

$fn.getUploadFiles()

プッシュボタンやアイコンボタンでアップロードしたファイルを取得します。[非同期]

Tips

Tips

本関数を使用するには、プッシュボタンやアイコンボタンの「クリックイベント」を「アップロード」に設定する必要があります。

引数

なし

戻り値

型	説明
Promise <FileInfo[]>	アップロードしたファイル情報

オブジェクト	プロパティ	型	説明
FileInfo	data	Buffer	ファイルデータ
	filename	string	ファイル名
	filesize	number	ファイルサイズ

サンプル

try {
  // 戻り値はオブジェクトの配列
  const files = await $fn.getUploadFiles();
  await Promise.all(files.map(async (file) => {
    const path = `/uploads/${file.filename}`;
    // 指定パスへファイルを保存
    await $fn.putFile(path, {
      data: file.data,
    });
  }));
} catch (err) {
  console.error("Error ", err);
}

$fn.getUsers(groupName?,option)

ユーザマネージャに存在するユーザを取得します。[非同期]

Tips

Tips

• 非同期関数であるため、コール時にawait式が必要になります。
• ユーザーマネージャに60人以上登録している場合、getUsers関数でデータ取得に要する時間が60に比例して増えていきます。

引数

名前	型	説明
groupName?	string	ユーザ抽出条件のグループ名
option	object	無効ユーザを含めるか指定

option詳細

名前	型	説明
disabled	boolean	true: 無効ユーザを含める false: 無効ユーザを含めない デフォルトはfalse

Tips

Tips

• groupNameが空やGlobalを指定した場合、実行環境のユーザをすべて返します。 無効ユーザを含めるか否かはoptionの指定に従います。
• optionを指定する場合、groupNameは省略はできません。 ただし、$fn.getUsers(); の記述は可能です。

戻り値

型	説明
Promise<User[]>	条件に一致するユーザリスト

オブジェクト	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	ユーザ名
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
    const users = await $fn.getUsers('group1',{disabled:true});
} catch (err) {
    console.log("Error", err)
}

$fn.link(url)

URL先を新規タブに表示する関数です。

Tips

Tips

ポップアップブロックが有効な時、link関数で指定したURL先を新規タブに表示することはできません。
ポップアップブロックを無効にしてください。

引数

名前	型	説明
url	string	Web サイトの URL

戻り値

なし

サンプル

$fn.link(‘https://google.com/’);

$fn.listUsersByEmail(email,option)

Emailによる前方一致検索をし、ユーザマネージャに存在するユーザを取得します。[非同期]

Tips

Tips

• 非同期関数であるため、コール時にawait式が必要になります。
• 検索条件に一致するユーザが60人以上いる場合、listUsersByEmail関数でデータ取得に要する時間が60に比例して増えていきます。

引数

名前	型	説明
email	string	検索文字列
option	object	無効ユーザを含めるか指定

option詳細

名前	型	説明
disabled	boolean	true: 無効ユーザを含める false: 無効ユーザを含めない デフォルトはfalse

Tips

Tips

emailが空の場合、実行環境のユーザをすべて返します。 無効ユーザを含めるか否かはoptionの指定に従います。

戻り値

型	説明
Promise<User[]>	条件に一致するユーザリスト

オブジェクト	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	ユーザ名
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
  const email = $ui.searchKey.value;
  // テーブルカラム「userId」「email」「name」があるテーブルに検索結果を表示
   $ui.userList.value = await $fn.listUsersByEmail(email,{disabled:true});
} catch(err) {
 console.log("Error", err);
}

$fn.listUsersByName(name,option)

ユーザ名による前方一致検索をし、ユーザマネージャに存在するユーザを取得します。[非同期]

Tips

Tips

• 非同期関数であるため、コール時にawait式が必要になります。
• 検索条件に一致するユーザが60人以上いる場合、listUsersByName関数でデータ取得に要する時間が60に比例して増えていきます。

引数

名前	型	説明
name	String	検索文字列
option	object	無効ユーザを含めるか指定

option詳細

名前	型	説明
disabled	boolean	true: 無効ユーザを含める false: 無効ユーザを含めない デフォルトはfalse

Tips

Tips

nameが空の場合、実行環境のユーザをすべて返します。 無効ユーザを含めるか否かはoptionの指定に従います。

戻り値

型	説明
Promise<User[]>	条件に一致するユーザリスト

オブジェク	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	ユーザ名
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
  const name = $ui.searchKey.value;
  // テーブルカラム「userId」「email」「name」があるテーブルに検索結果を表示
  $ui.userList.value = await $fn.listUsersByName(name,{disabled:true});
} catch(err) {
 console.log("Error", err);
}

$fn.message(parameters)

スナックバーコンポーネントにより、スクリーンにメッセージを表示します。

引数

名前	型	説明
parameters	object	メッセージ内容を示すオブジェクト

parameters詳細

プロパティ	型	説明
message	string	表示するメッセージ文字列
close	boolean	メッセージをクローズするボタン - 表示する (デフォルト) - 表示しない
autoHideDuration	number	自動クローズまでの時間 (ミリ秒)
severity	string	アラート表示の指定 - none (デフォルト) - error - warning - info - success
position	string	表示位置の指定 - bottom-left - bottom-center (デフォルト) - bottom-right - top-left - top-center - top-right
transitionDuration	number	スナックバーの表示とフェードアウトの時間 (ミリ秒)

Tips

Tips

• [autoHideDuration]プロパティの設定を有効にするためには、[close]プロパティを表示しない(false)にしてください。
• メッセージは複数表示することはできません。 1つのアクション内で複数回$fn.message関数を実行した場合、最後に実行されたメッセージだけ表示します。
• 表示するメッセージは改行することはできません。

戻り値

なし

サンプル

$fn.message(
    {
    message: "Hello world.",
    close: false,
    autoHideDuration: 1000,
    severity: "info",
    transitionDuration: 300,
    }
 );

$fn.nextUI(uiCode)

スクリーンを別のUIに遷移させる関数です。

引数

名前	型	説明
uiCode	string	遷移先 UI の ID

Tips

Tips

遷移先UIのIDに存在しないUIのIDを指定した場合、error.htmlに遷移します。 画面にはエラーメッセージ等は表示されないため、真っ白な画面になります。

戻り値

なし

サンプル

$fn.nextUI(‘UI01’);

$fn.putFile(path, parameters)

指定パスへファイルを保存します。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
path	string	保存するファイルのパス
parameters	object	data: Buffer | Unit8Array | string をプロパティに持つオブジェクト

Tips

Tips

• Unit8Array はバイト配列です。stringを指定した場合は、指定文字列を記述したテキストファイルになります。
• [path]に既存のファイルパスを指定した場合は上書きします。
• [path]に存在しないフォルダを含むパスを指定した場合はフォルダは自動作成します。
• [path]に空、undefined、nullを指定した場合、処理は無視します。

戻り値

なし

サンプル

try {
    const obj = await $fn.getFile("/note.dat");
    await $fn.putFile('filePath', obj);
 } catch (err) {
    console.log("Error", err);
 }

$fn.removeUsers(param)

アプリケーションの認可グループから登録しているユーザを除外します。[非同期]

Tips

Tips

• 非同期関数であるため、コール時にawait式が必要になります。
• グループからのユーザ削除は１回につき最大100人までにしてください。
  それ以上のユーザを指定した場合は、実行時にエラーが発生し、グループに所属しているユーザ数がずれる場合があります。
  100人を超えるユーザをグループから削除する場合は、分割して削除をしてください。

引数

名前	型	説明
param	object	グループ名と除外するユーザ情報

param詳細

プロパティ	型	説明
groupName	string	グループ名
emails	array of string	グループから除外するユーザのメールアドレス配列

戻り値

なし

サンプル

try {
  /* CSV の内容
   * ---------------------------
   * "email"
   * "user01@test.co.jp"
   * "user02@test.co.jp"
   * ---------------------------
   */
    const file = await $fn.getFile('/removeUsers.csv');
    const buffer = file.data;
    const addUsers = $fn.csvToObject(buffer);
    const emails = addUsers.map(function (item) {
        return item['email'];
    });
    // 認可グループ「Group01」からユーザ除外
    await $fn.removeUsers({
    groupName: "Group01",
    emails: emails
 });
} catch(err) {
 console.log("Error", err);
}

$fn.resetPassword(param)

アプリケーションの認証ユーザのパスワードをリセットします。[非同期]

Tips

Tips

非同期関数であるため、コール時にawait式が必要になります。

引数

名前	型	説明
param	object	パスワードリセットするユーザの情報

param詳細

プロパティ	型	説明
email	string	Eメール
password	string	一時パスワード

戻り値

型	説明
Promise<User>	パスワードリセットしたユーザ情報

オブジェクト	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	名前
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
  /* CSV の内容
   * ------------------------------------
   * "email","password"
   * "user01@test.co.jp","Password@01"
   * "user02@test.co.jp","Password@02"
   * ------------------------------------
   */
    const file = await $fn.getFile('/resetPassword.csv');
    const buffer = file.data;
    const resetPWInfos = $fn.csvToObject(buffer);
    // リセットパスワード
    for (let resetPWInfo of resetPWInfos) {
        await $fn.resetPassword(resetPWInfo);
    }
} catch(err) {
    console.log("Error", err);
}

$fn.sendMail(param)

メールを送信します。[非同期]

Tips

Tips

• 送信元メールアドレスは、デフォルト「no-reply@webperformer.jp」です。
• フリー実行環境では、送信元メールアドレスを変更することはできません。
• メール送信時の制限事項は下記になります。
  • 1回のメール送信先の最大数は50件です。送信先は、「To」、「CC」、「BCC」に指定したすべてのメールアドレスの合計数です。
  • 1日にメール送信できる最大数は50000件です。ただし、ご契約のプランによって月に送れるメール送信数が異なりますので、ご契約プランをご確認ください。
  • 1 秒あたりに送信できるメール送信数は最大14件です。

引数

名前	型	説明
param	object	メール送信内容を示すパラメータオブジェクト

param 詳細

プロパティ	型	説明
to	string array	TO アドレス (複数)
cc	string array	CC アドレス (複数)
bcc	string array	BCC アドレス (複数)
fromAddress	string	Fromアドレス
fromName	string	From 表示名
subject	string	サブジェクト
text	string	本文
encoding	boolean	true: fromNameをBase64エンコーディングする false: fromNameをBase64エンコーディングしない デフォルトはfalse

Tips

Tips

• [to],[subject],[text]プロパティは必須項目です
• [text]プロパティの値に改行を含める場合は、改行コード\nを入れてください。
• [to],[cc],[bcc]の配列の値に空文字("")を指定しないでください。指定した場合はエラーになります。
• [fromAddress]には、送信元メールアドレス検証のページでメール検証済みのメールアドレスを設定してください。検証済み以外のメールアドレスを設定した場合はエラーになります。
• [fromName] は任意の表示名が可能です。
  指定した表示名に「“（ダブルクォート）」「,（カンマ）」「:（コロン）」「<（小なり）」「>（大なり）」「(（小括弧）」「)（小括弧閉じ）」「[（大括弧）」「;（セミコロン）」を含む場合は、指定した表示名が期待通りに表示されない、エラーになる場合がありますので、[encoding]をtrueに設定してください。
• [fromAddress] ,[fromName] の設定によって送信元の表示形式が下記のようになります。フリー実行環境の場合、[fromAddress] ,[fromName]を設定しても設定は無視します。

実行環境	fromAddress	fromName	送信元の表示形式
フリー実行環境	-（設定不可）	-（設定不可）	no-reply@webperformer.jp
プレミアム実行環境	指定あり	指定なし	設定したメールアドレス
プレミアム実行環境	指定なし	指定あり	設定した表示名 no-reply@webperformer.jp
プレミアム実行環境	指定あり	指定あり	設定した表示名 <設定したメールアドレス>

戻り値

なし

Tips

Tips

プロパティ値のバリデーションチェックエラー、またはAmazon SESのエラーをthrowします。

サンプル

 try {
     let toArray=["user01@test.co.jp"];
     let textValue = $ui.text.value;
     let subjectValue = $ui.subject.value;
     const params = {
         to: toArray,
         text: textValue,
         subject: subjectValue
      };
     await $fn.sendMail(params);
 } catch(err) {
     console.log("Error", err);
 }

$fn.setLanguage(language)

表示言語を変更します。

引数

名前	型	説明
language	string	[default | en | ja] のいずれかの値を設定

戻り値

なし

サンプル

$fn.setLanguage(‘en’);

$fn.signOut()

サインアウトします。

Tips

Tips

• サインアウト後は自動的にサインイン画面に遷移します。
• サインアウトを行う際、$paramに値を設定することでサインイン画面で値を取得できます。

引数

なし

戻り値

なし

サンプル

$fn.signOut();

$fn.updateUser(param)

アプリケーションの認証ユーザを更新します。[非同期]

Tips

Tips

• 非同期関数であるため、コール時にawait式が必要になります。
• 外部認証ユーザを更新することはできません。

引数

名前	型	説明
param	object	更新するユーザ情報

param詳細

プロパティ	型	説明
originalEmail	string	Eメール（更新前）
email	string	Eメール（更新後）
name	string	名前
enabled	boolean	true：有効 false：無効 デフォルトはtrue
custom_01	string	カスタム属性1
custom_02	string	カスタム属性2
custom_03	string	カスタム属性3
custom_04	string	カスタム属性4
custom_05	string	カスタム属性5
custom_06	string	カスタム属性6
custom_07	string	カスタム属性7
custom_08	string	カスタム属性8
custom_09	string	カスタム属性9
custom_10	string	カスタム属性10

Tips

Tips

Eメールを変更しない場合は[originalEmail], [email]両方同じメールアドレスを設定してください。

戻り値

型	説明
Promise<User>	更新したユーザ情報

オブジェクト	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	名前
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
  /* CSV の内容
   * ---------------------------------------------------------
   * "originalEmail","email","name","enabled"
   * "user01@test.co.jp","user01@test.co.jp","User01",ture
   * "user02@test.co.jp","user02@test.co.jp","User02",false
   * ---------------------------------------------------------
   */
    const file = await $fn.getFile('/updateUserInfo.csv');
    const buffer = file.data;
    const userInfos = $fn.csvToObject(buffer);
    for (let userInfo of userInfos) {
        let data = {};
        data = {
            originalEmail: userInfo['originalEmail'],
            email: userInfo['email'],
            name: userInfo['name'],
            enabled: JSON.parse(userInfo['enabled'])
        };
        // ユーザ更新
        const result = await $fn.updateUser(data);
  }
} catch(err) {
    console.log("Error", err);
}