Built-in Functions

Actions have functions that are provided from the start. This is called a built-in function. Built-in functions correspond to methods of the object $fn and can be called in the form $fn.XXX.

Tips

Tips

Some built-in functions are asynchronous functions. When calling an asynchronous function, it is necessary to use an await expression to wait until the result is returned. When an error occurs, the catch clause receives the error object returned by the Amazon SDK.

$fn.addUsers(param)

Add users to the application’s authorization group. "asynchronous"

Tips

Tips

• Since this is an asynchronous function, an await expression is required at call time.
• Please limit user registration to a maximum of 100 users at a time.
  If more than 100 users are specified, an error will occur at runtime and the number of users belonging to the group may deviate. When registering more than 100 users to a group, please divide the registration into separate groups.

Arguments

Name	Type	Description
param	object	Group name and user information to add

parameters details

Property	Type	Description
groupName	string	Group Name
emails	array of string	Array of email addresses of users to add to the group

Return value

None

Sample

try {
  /* CSV content
   * ---------------------------
   * "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'];
    });
    // Add user to authorization group [Group01]
    await $fn.addUsers({
        groupName: "Group01",
        emails: emails
    });
}catch(err) {
   console.log("Error", err);
}

$fn.createFolder(path)

Creates a folder in the specified path. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
path	string	Path of the folder to be created

Tips

Tips

If an existing folder path, empty, undefined, or null is specified for "path", processing will ignore it.

Return value

None

Sample

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

$fn.createGroup(param)

Add an authorization group for the application. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
param	object	Group information to be registered

parameters details

Property	Type	Description
groupName	string	Group Name
description	string	Details

Return value

Type	Description
Promise<Group>	Registered Group Information

Object	Property	Type	Description
Group	groupName	string	Group Name
	description	string	Description
	members	object array	Active user array belonging to group

Tips

Tips

In case of an error, an error object with the following keys is returned as the return value.

• errorType
• errorMessage
• trace

Sample

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)

Add an authenticated user for the application. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
param	object	User information to be registered

parameters details

Property	Type	Description
email	string	Email (string used for sign-in ID)
name	string	Name
password	string	Temporary password
sendMail	boolean	true: Send issue mail false: Do not send issue mail Default is false
custom_01	string	Custom Attribute 1
custom_02	string	Custom Attribute 2
custom_03	string	Custom Attribute 3
custom_04	string	Custom Attribute 4
custom_05	string	Custom Attribute 5
custom_06	string	Custom Attribute 6
custom_07	string	Custom Attribute 7
custom_08	string	Custom Attribute 8
custom_09	string	Custom Attribute 9
custom_10	string	Custom Attribute 10

Tips

Tips

For maximum characters and restrictions on e-mail, name, temporary password, and custom attributes, please refer to the user creation page.

Return value

Type	Description
Promise<User>	Registered User Information

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Tips

Tips

In case of an error, an error object with the following keys is returned as the return value.

• errorType
• errorMessage
• trace

Sample

try {
  /* CSV content
   * -----------------------------------------------------
   * "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'])
         };
         // Add User
         let result=await $fn.createUser(data);
         if(result.errorType){
           throw new Error (result.errorMessage);
     }
      }
} catch(err) {
    console.log("Error", err.message);
}

$fn.csvToObject(csv)

Converts the specified CSV file data to object format.

Arguments

Name	Type	Description
csv	Buffer	Buffer object in CSV file

CSV File Specifications

Header	Required This is the name of the object’s property. Only single-byte alphanumeric characters are allowed. (Starting with a numeral is not acceptable.) Example）“email”, “name”
Delimiter	,（comma）
Field	If the value contains double quotes,commas, or line breaks, be sure to enclose them.
Newline Character	CRLF or LF
Encoding	UTF-8
BOM	Without BOM or with BOM

Return value

Type	Description
array of object	Converts CSV file data to object format and returns it

Tips

Tips

• The header name of the CSV file becomes the property name of the object.
• After conversion to object format, each value is returned as a string.
• If the CSV file does not conform to the specifications, an exception message is thrown.

Sample

try {
  /* CSV Contents
   * ----------------------------------------------------------------------------
   * Id,Title,Description,Progress,Category,CreatedBy,CreatedAt
   * 00001,Title 1,"Description 1, Sample 1",100,CATEGORY1,User1,2023-08-01
   * 00002,Title 2," Description 2, Sample 2",80,CATEGORY2,User2,2023-08-10
   * 00003,Title 3," Description 3, Sample 3",20,CATEGORY3,User3,2023-08-12
   * ----------------------------------------------------------------------------
   */
  const file = await $fn.getFile("/path/to/projects.csv");
  const buffer = file.data;
  // Parses CSV files and converts them to objects
  const projects = $fn.csvToObject(buffer);
  // Register data one case at a time
  for (const project of projects) {
    const { Id, Title, Description, Category, Progress, CreatedBy, CreatedAt } = project;
    if (!Id) {
      throw new Error("Please enter ID.");
    }
    const progress = Number(Progress);
    if (isNaN(progress)) {
      throw new Error("Enter the percentage of progress with numeric.");
    }
  /* SQL Function Content
   * ------------------------------------------------------------------------------------
   * insert into Project VALUES  (${param.id},${param.title},${param.description},
   * ${param.progress},${param.category},${param.createdBy},${param.createdAt});
   * ------------------------------------------------------------------------------------
   */
   // Register data in tables with SQL functions
    await insertToProjectTable({
      id: Id,
      title: Title,
      description: Description,
      progress,
      category: Category,
      createdBy: CreatedBy,
      createdAt: CreatedAt
     });
  }
} catch (e) {
  console.error(e);
}

$fn.deleteFile(path)

Deletes files in the specified path. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
path	string	Path of the file to be deleted

Tips

Tips

If "path" is specified as empty, undefined, or null, the process ignores it.

Return value

None

Sample

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

$fn.deleteFolder(path)

Deletes folder in the specified path. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
path	string	Path of the folder to be deleted

Tips

Tips

• When "path" is specified as /, all files and folders are deleted from the root.
• When "path" is specified as empty, undefined, or null, the process ignores it.

Return value

None

Sample

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

$fn.deleteUser(email)

Deletes the authenticated user of the application. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
email	string	Email of user to be deleted

Return value

None

Tips

Tips

In case of an error, an error object with the following keys is returned as the return value.

• errorType
• errorMessage
• trace

Sample

try {
  /* CSV content
   * ---------------------------
   * "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'];
     });
     // Delete User
     for (let email of emails) {
         console.log(email);
         await $fn.deleteUser(email);
      }
} catch(err) {
    console.log("Error", err);
}

$fn.download(file, filename)

Download the specified file locally. The name of the file to be downloaded, can be specified. "asynchronous"

Tips

Tips

Browser restrictions allow only one file to be downloaded per action.

Arguments

Name	Type	Description
file	Buffer	Buffer object of the file to download
filename	string	File name to download

Return value

None

Sample

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()

Obtains the current location of the smartphone device.

Tips

Tips

Only available for mobile application actions.

Arguments

None

Return value

Type	Description
GeolocationCoordinates	Device Location

Sample

Tips

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

$fn.getCurrentUser()

Retrieves the user who is signed in. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

None

Return value

Type	Description
User	Returns the user currently signed in

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Sample

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

$fn.getFile(path)

Retrieves the file at the specified path. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
path	string	Path of file to be retrieved

Tips

Tips

If "path" is specified as empty, undefined, or null, the process ignores it.

Return value

Type	Description
Promise<{data: Buffer}>	Object with properties of binary data (data: Buffer type) to be retrieved from Amazon S3

Tips

Tips

If the file is text and you want to retrieve the content string, you can use Buffer#toString().

Sample

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)

Obtains a list of file names in a specified directory path. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
path	string	Path of the directory to be retrieved

Return value

Type	Description
array of string	List of file names in target directory

Tips

Tips

When external authentication is linked by an external IdP, the user information email may not be unique.
If the user information email is not unique, specify the user ID (GUID) in the "userIds" property.

Sample

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

$fn.getGroups(option)

Retrieves all groups that exist in the user manager. "asynchronous"

Tips

Tips

• Since this is an asynchronous function, an await expression is required at call time.
• The group name "Global" cannot be obtained.

Arguments

Name	Type	Description
option	object	Specify whether to include invalid users

Option Details

Name	Type	Description
containUsers	boolean	true: Include users belonging to the group false: Do not include users belonging to the group Default is true

Return value

Type	Description
Promise<Group[]>	Group list

Object	Property	Type	Description
Group	groupName	string	Group Name
	description	string	Description
	members	object array	Active user array belonging to group

Sample

try {
    // Obtain group information not including users belonging to the group
    const groups = await $fn.getGroups({containUsers:false});
    console.log(groups);
} catch (err) {
    console.log("Error", err);
}

$fn.getLanguage()

Gets the currently displayed language.

Arguments

None

Return value

Type	Description
string	Returns one of the values of "default | en | ja"

Sample

const lang = $fn.getLanguage();

$fn.getPresignedUrl(path,options)

Issues a signed URL to access a file manager in the WebPerformerNX execution environment. "asynchronous"

Tips

Tips

• This function is available only in the Premium Execution Environment.
• As an asynchronous function, it requires an await expression at call time
• By specifying the path of a file to which access rights are to be granted, the file can be uploaded/downloaded for a specified valid time.
  • File uploads are limited to a maximum of 5 GB.
  • There is no limit to the validity time, but for security reasons, we do not recommend setting a long validity time.

Argument

Name	Type	Description
path	string	File path of the file manager issuing the signed URL Support for the following query parameter Query Parameter Description response-content-type Override Content-type in response headers If not specified, binary/octet-stream is set response-cache-control Override Cache-control in response headers
options	object	Signed URL validity time

Options Details

Property	Type	Description
expiresIn	number	Validity time of signed URL (seconds) Default is 900

Tips

Tips

• Two types of wildcards can be specified in the "path" property
  • Asterisk (*): matches zero or more characters
  • Question mark (?): matches one character
• If the "path" property contains multibyte or special symbols (#$&+,/:;=?@) must be encoded.
  • If the path contains multibytes, the entire path must be encoded with the encodeURI function.
  • If the path contains special symbols, encode the part containing the special symbols individually with the encodeURIComponent function and combine the path.
• The maximum number of bytes for a character in the "path" property is 988 bytes.
• When granting access to a folder, specify a wildcard in the "path" property to grant access under the folder, such as "/folder name/*".
  • When using a signed URL issued with a wildcard, change the wildcard part to a file name.
• When including query parameters in the "path" property, ? must be escaped with a backslash.
• If the "path" property contains a response-content-type, the MIME type slash is encoded. Published signed URLs must be converted back to slashes before they can be used.
• File downloads in cache-enabled browsers may be downloaded from disk cache outside the validity time. Do not use query parameters to save the cache.

Return value

Type	Description
String	Signed URL

Sample

// Query parameter (cache:don't save, MIME type:application/pdf) specified in file path
const path = $ui.filePath.value + "\?response-cache-control=no-store&response-content-type=application/pdf";
// Issuing a signed URL with a validity time of 10 minutes
$ui.url.value = await $fn.getPresignedUrl(path, {expiresIn:600});

Tips

Tips

Expiration Date of Signed URL
If the client starts downloading a large file just before the expiration time, the download will complete even if the expiration time elapses during the download.
If the TCP connection is interrupted and the client resumes the download after the expiration time has elapsed, the download will fail.

Tips

Tips

Example of procedure for uploading a file using a signed URL This is an example of uploading a file by executing the curl command.

1. Issue a signed URL that gives access rights under the folder to be accessed for the “path”property.
   Eg：await $fn.getPresignedUrl(‘/My_Folder/*’, {expiresIn:600});

2. Change the wildcard portion (*) of the URL issued in step 1 to the filename to be uploaded to the file manager.
   Eg: Set the name of the file to be uploaded as sample.jpg.
   https://<domain>/<owner ID>/My_Folder/sample.jpg?Policy=・・・

3. Execute the curl command to upload the file.
   Eg: curl -X PUT —upload-file C:\temp\sample.jpg “Signed URL updated in step 2”

$fn.getUploadFiles()

Retrieve files uploaded with the push button or icon button."asynchronous"

Tips

Tips

To use this function, the "click event" of a push button or icon button must be set to "upload".

Arguments

None

Return value

Type	Description
Promise <FileInfo[]>	Uploaded file information

Object	Property	Type	Description
FileInfo	data	Buffer	File data
	filename	string	File name
	filesize	number	File size

Sample

try {
  // The return value is an array of objects
  const files = await $fn.getUploadFiles();
  await Promise.all(files.map(async (file) => {
    const path = `/uploads/${file.filename}`;
    // Save the file to the specified path
    await $fn.putFile(path, {
      data: file.data,
    });
  }));
} catch (err) {
  console.error("Error ", err);
}

$fn.getUsers(groupName?,option)

Retrieves the users present in the User Manager."asynchronous"

Tips

Tips

• Since this is an asynchronous function, an await expression is required at call time.
• If more than 60 users are registered in the user manager, the time required to retrieve data with the getUsers function will increase in proportion to 60.

Arguments

Name	Type	Description
groupName?	string	Group name for user extraction conditions
option	object	Specify whether to include invalid users

Option details

Name	Type	Description
disabled	boolean	true: Include invalid users false: Do not include invalid users. Default is false

Tips

Tips

• If groupName is empty or Global is specified, all users in the execution environment are returned.
  Whether invalid users are included or not depends on the option specified.
• When option is specified, groupName cannot be omitted.
  However, $fn.getUsers(); can be written.

Return value

Type	Description
Promise<User[]>	List of users matching the criteria

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Sample

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

$fn.link(url)

Function to display the URL destination in a new tab.

Tips

Tips

When pop-up blocking is enabled, the URL destination specified by the link function cannot be displayed in a new tab.
Please disable your pop-up blocker.

Arguments

Name	Type	Description
url	string	Website URL

Return value

None

Sample

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

$fn.listUsersByEmail(email,option)

Performs forward match search by Email to retrieve users present in the user manager. "asynchronous"

Tips

Tips

• As this is an asynchronous function, an await expression is required at call time.
• If there are more than 60 users matching the search criteria, the time required to retrieve data with the listUsersByEmail function will increase in proportion to 60.

Argument

Name	Type	Description
email	string	Search string
option	object	Specify whether to include invalid users

option details

Name	Type	Description
disabled	boolean	true: Include disabled users false: Do not include invalid users Default is false

Tips

Tips

If email is empty, all users in the execution environment are returned.
Whether or not invalid users are included depends on the option specified.

Return value

Type	Description
Promise<User[]>	List of users matching the criteria

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	User Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Sample

try {
  const email = $ui.searchKey.value;
  // Display search results in table with table columns "userId", "email", and "name"
   $ui.userList.value = await $fn.listUsersByEmail(email,{disabled:true});
} catch(err) {
 console.log("Error", err);
}

$fn.listUsersByName(name,option)

Performs a forward match search by user name to retrieve users present in the user manager. "asynchronous"

Tips

Tips

• As this is an asynchronous function, an await expression is required at call time.
• If there are more than 60 users matching the search criteria, the time required to retrieve data with the listUsersByName function will increase in proportion to 60.

Arguments

Name	Type	Description
name	String	Search string
option	object	specify whether to include invalid users

Option details

Name	Type	Description
disabled	boolean	true: Include disabled users false: Do not include invalid users Default is false

Tips

Tips

If name is empty, all users in the execution environment are returned.
Whether invalid users are included or not depends on the option specified.

Return value

Type	Description
Promise<User[]>	List of users matching the criteria

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	User Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Sample

try {
  const name = $ui.searchKey.value;
  // Display search results in table with table columns "userId", "email", and "name"
  $ui.userList.value = await $fn.listUsersByName(name,{disabled:true});
} catch(err) {
 console.log("Error", err);
}

$fn.message(parameters)

The snack bar component displays a message on the screen.

Arguments

Name	Type	Description
parameters	object	Object indicating message content

parameters details

Property	Type	Description
message	string	Message string to be displayed
close	boolean	Button to close the message - Show (default) - Hide
autoHideDuration	number	Time to auto-close (ms)
severity	string	Specify alert display - none (default) - error - warning - info - success
position	string	Specify display position - bottom-left - bottom-center (default) - bottom-right - top-left - top-center - top-right
transitionDuration	number	Snack bar display and fade-out time (milliseconds)

Tips

Tips

• To enable the "autoHideDuration"property setting, set the "close"property to not display (false).
• Multiple messages cannot be displayed.
  If $fn.message function is executed multiple times within one action, only the last message executed is displayed.
• The message to be displayed cannot be line-breaking.

Return value

None

Sample

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

$fn.nextUI(uiCode)

Function to transition the screen to another UI.

Arguments

Name	Type	Description
uiCode	string	ID of target UI

Tips

Tips

If the ID of a non-existent UI is specified in the ID of the destination UI, the user will be redirected to error.html.
The screen will be blank, with no error messages or other information displayed on the screen.

Return value

None

Sample

$fn.nextUI(‘UI01’);

$fn.putFile(path, parameters)

Saves the file to the specified path. "asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
path	string	Path of the file to save
parameters	object	data: Buffer | Unit8Array | Objects with string as a property

Tips

Tips

• Unit8Array is a byte array; if string is specified, it is a text file describing the specified string.
• If "path" is specified as an existing file path, it is overwritten.
• If a path including a nonexistent folder is specified in "path", the folder is automatically created.
• If "path" is specified as empty, undefined, or null, the process ignores it.

Return value

None

Sample

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

$fn.removeUsers(param)

Exclude registered users from application authorization groups."asynchronous"

Tips

Tips

• Since this is an asynchronous function, an await expression is required at call time.
• Please make sure that the maximum number of users to be removed at one time from a group is 100.
  If more than 100 users are specified, an error will occur at runtime and the number of users belonging to the group may vary.
  When deleting more than 100 users from a group, please divide the group and delete them separately.

Arguments

Name	Type	Description
param	object	Group name and user information to be excluded

param details

Property	Type	Description
groupName	string	Group Name
emails	array of string	Array of email addresses of users to exclude from the group

Return value

None

Sample

try {
  /* CSV content
   * ---------------------------
   * "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'];
    });
    // Exclude users from authorization group [Group01]
    await $fn.removeUsers({
    groupName: "Group01",
    emails: emails
 });
} catch(err) {
 console.log("Error", err);
}

$fn.resetPassword(param)

Reset application authenticated user passwords."asynchronous"

Tips

Tips

Since this is an asynchronous function, an await expression is required at call time.

Arguments

Name	Type	Description
param	object	Information about the user whose password is to be reset

param details

Property	Type	Description
email	string	Email
password	string	Temporary password

Return value

Type	Description
Promise	Password reset user information

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Sample

try {
  /* CSV content
   * ------------------------------------
   * "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);
    // reset password
    for (let resetPWInfo of resetPWInfos) {
        await $fn.resetPassword(resetPWInfo);
    }
} catch(err) {
    console.log("Error", err);
}

$fn.sendMail(param)

Send an email. "asynchronous"

Tips

Tips

• The default Email Address Identities is"no-reply@webperformer.jp".
• In the free execution environment, it is not possible to change the Email Address Identities.
• The following restrictions apply when sending mail.
  • Maximum number of recipients is 50 at a time.
    Number of recipients is the total number of all e-mail addresses specified in the “To,” “CC,” and “BCC” fields.
  • Maximum number of e-mails that can be sent per day is 5,000.
    However, the number of e-mails that can be sent per month varies depending on the plan you are subscribed to.
  • Maximum number of e-mails that can be sent per second is 14.

Arguments

Name	Type	Description
param	object	Parameter object indicating the contents of the email transmission

param details

Property	Type	Description
to	string array	TO address (multiple)
cc	string array	CC address (multiple)
bcc	string array	BCC address (multiple)
fromAddress	string	From address
fromName	string	From Name
subject	string	Subject
text	string	Body
encoding	boolean	true: Base64 encoding of fromName false: Do not Base64-encode fromName Default is false

Tips

Tips

• The"to", "subject","text"properties are required fields.
• To include a line break in the value of the textproperty, include the line break code \n.
• Do not use empty ("") in array value for "to","cc" and "bcc". Otherwise there will be an error.
• In "fromAddress", please set the email address that has already been email verified on the Email Address Identities page. If an email address other than the verified one is set, an error will occur.
• The "fromName"can be any display name.
• If the specified display name contains "" (double quote), ”,” (comma), ”:” (colon), ”<” (smaller), ”>” (greater), ”(” (opening parenthesis), ”)” (closing parenthesis), ”[” (closing square bracket), ”;” (semicolon), the specified display name may not be displayed as expected or an error may occur. Please set"encoding" to true.
• The format of the sender’s display will be as follows depending on the settings of "fromAddress" and "fromName".
  In the free execution environment, the settings are ignored even if "fromAddress" and"fromName"are set.

Execution Environment	fromAddress	fromName	Email Address Identities format
Free	-（not available）	-（not available）	no-reply@webperformer.jp
Premium	available	not available	configured address
Premium	not available	available	configured name no-reply@webperformer.jp
Premium	available	available	configured name

Return value

None

Tips

Tips

Throw property value validation check errors or Amazon SES errors.

Sample

 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)

Change the display language.

Arguments

Name	Type	Description
language	string	Set one of the values of "default | en | ja"

Return value

None

Sample

$fn.setLanguage(‘en’);

$fn.signOut()

Sign out.

Tips

Tips

• After signing out, you will automatically be redirected to the sign-in screen.
• When signing out, a value can be set to $param to get the value on the sign-in screen.

Arguments

None

Return value

None

Sample

$fn.signOut();

$fn.updateUser(param)

Update the application’s authenticated users. "asynchronous"

Tips

Tips

• Since this is an asynchronous function, an await expression is required at call time.
• External authenticated users cannot be updated.

Arguments

Name	Type	Description
param	object	User information to update

param details

Property	Type	Description
originalEmail	string	Email（before update）
email	string	Email（after update）
name	string	Name
enabled	boolean	true: Enabled false: Disabled Default is true
custom_01	string	Custom Attribute 1
custom_02	string	Custom Attribute 2
custom_03	string	Custom Attribute 3
custom_04	string	Custom Attribute 4
custom_05	string	Custom Attribute 5
custom_06	string	Custom Attribute 6
custom_07	string	Custom Attribute 7
custom_08	string	Custom Attribute 8
custom_09	string	Custom Attribute 9
custom_10	string	Custom Attribute 10

Tips

Tips

If you do not change your e-mail address, please set the same e-mail address for both "originalEmail" and "email".

Return value

Type	Description
Promise<User>	Updated user information

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	Name
	custom_01	string	Custom Attribute 1
	custom_02	string	Custom Attribute 2
	custom_03	string	Custom Attribute 3
	custom_04	string	Custom Attribute 4
	custom_05	string	Custom Attribute 5
	custom_06	string	Custom Attribute 6
	custom_07	string	Custom Attribute 7
	custom_08	string	Custom Attribute 8
	custom_09	string	Custom Attribute 9
	custom_10	string	Custom Attribute 10
	enabled	boolean	Enable/Disable
	created	string	Creation date and time
	updated	string	Update date and time
	status	string	User Status

Sample

try {
  /* CSV content
   * ---------------------------------------------------------
   * "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'])
        };
        // Update User
        const result = await $fn.updateUser(data);
  }
} catch(err) {
    console.log("Error", err);
}