Script

The RunScript method is used to invoke cloud code scripts from the client.

Cloud Code scripts can be created, edited, and tested from the Edit Scripts page of the brainCloud portal.

tip

Scripts must have the “Client Callable” flag set to True to be callable from client apps.

API Summary

Script

• CancelScheduledScript - Cancels a previously scheduled script.
• GetRunningOrQueuedCloudScripts - Retrieves scripts are running up and queued by server.
• GetScheduledCloudScripts - Retrieves scripts scheduled to run up to and including the specified start time (UTC in ms).
• RunParentScript - Runs a script against the level of parent from.
• RunPeerScript - Runs a script against the level of peer from.
• RunPeerScriptAsync - Runs a script against the level of peer from with async way.
• RunScript - Executes a script on the server.
• ScheduleRunScriptMinutes - Schedules a script to run on the server at a later time in minutes from now.
• ScheduleRunScriptMillisUTC - Schedules a script to run on the server at a later time in UTC format.
• ScheduleRunScriptUTC - Schedules a script to run on the server at a later time in UTC format.
• ScheduleRunScriptUTCv2 - Schedules a script to run on the server at a later time in UTC format.
• SysCancelScheduledScriptIfExists - Cancels a previously scheduled script, if it exists and is still in Scheduled state.
• SysCancelUserScriptBatchIfExists - Cancels a user script batch, if it exists and is in Scheduled, Queued or Running state.

📄️ CancelScheduledScript

Cancels a scheduled script

📄️ GetRunningOrQueuedCloudScripts

Retrieves scripts currently running or queued.

📄️ GetScheduledCloudScripts

Retrieves list of scheduled cloud scripts having a scheduled start time

📄️ RunParentScript

Run a cloud script in a parent app.

📄️ RunPeerScript

Run a cloud script in a peer app.

📄️ RunPeerScriptAsync

Run a cloud script asynchronously in a peer app.

📄️ RunScript

Executes a script on the server.

📄️ ScheduleRunScriptMillisUTC

Schedules a script to run at given UTC time.

📄️ ScheduleRunScriptMinutes

Schedules a script to run X minutes from now.

📄️ ScheduleRunScriptUTC

Schedules a script to run at given UTC time.

📄️ ScheduleRunScriptUTCv2

Schedules a script to run at given UTC time.

📄️ SysCancelScheduledScriptIfExists

Cancels a previously scheduled script, if it exists and is still in Scheduled state. Silently fails, if job does not exist, just returns null and success, instead of an error.

📄️ SysCancelUserScriptBatchIfExists

Cancels a user script batch, if it exists and is in Scheduled, Queued or Running state. Silently fails, if job does not exist, just returns null and success, instead of an error.