Script
Overview
This service allows you to execute cloud code scripts
API Summary
Script
- ScheduleCloudScript - Schedules a script to run on the server at a later date.
- RunBatchUserScript - Runs a script against every user in the provided segments or all.
- RunBatchUserScriptAndCompletionScript - Runs a script against every user in the app and then a completion script at the end.
- RunBatchUserScriptForProfilesAndCompletionScript - Runs a script against the specified users and then a completion script at the end.
- RunBatchUserScriptForSegmentsAndCompletionScript - Runs a script against the users in the specified segments and then a completion script at the end.
- RunScript - Executes a script on the server.
- ScheduleBatchUserScript - Schedules a script to run on the server at a later date.
- CancelScheduledScript - Cancels a previously scheduled script.
- GetScheduledCloudScripts - Retrieves scripts scheduled to run up to and including the specified start time (UTC in ms).
- GetRunningOrQueuedCloudScripts - Retrieves scripts are running up and queued by server.
- 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.
tip
All the client APIs that the names beigin with "Sys" are also available to S2S. For the usages of the S2S script APIs (if they are not listed at this section below), refer to brainCloud client script APIs.
📄️ CancelScheduledScript
Overview
📄️ GetRunningOrQueuedCloudScripts
Overview
📄️ GetScheduledCloudScripts
Overview
📄️ RunBatchUserScript
Overview
📄️ RunBatchUserScriptAndCompletionScript
Overview
📄️ RunBatchUserScriptForProfilesAndCompletionScript
Overview
📄️ RunBatchUserScriptForSegmentsAndCompletionScript
Overview
📄️ RunScript
Overview
📄️ ScheduleBatchUserScript
Overview
📄️ ScheduleCloudScript
Overview