playfab_ex v0.2.0 PlayfabEx.Admin.ScheduledTask

Link to this section Summary

Functions

Abort an ongoing task instance

Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action

Create a CloudScript task, which can run a CloudScript on a schedule

Delete a task

Get information about a ActionsOnPlayersInSegment task instance

Get detail information about a CloudScript task instance

Query for task instances by task, status, or time range

Get definition information on a specified task or all tasks within a title

Run a task immediately regardless of its schedule

Update an existing task

Link to this section Functions

Link to this function abort_task_instance(params)
abort_task_instance(map()) :: {:ok, map()} | {:error, String.t()}

Abort an ongoing task instance.

online docs

Link to this function create_actions_on_players_in_segment_task(params)
create_actions_on_players_in_segment_task(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.

online docs

Link to this function create_cloud_script_task(params)
create_cloud_script_task(map()) :: {:ok, map()} | {:error, String.t()}

Create a CloudScript task, which can run a CloudScript on a schedule.

online docs

Link to this function delete_task(params)
delete_task(map()) :: {:ok, map()} | {:error, String.t()}

Delete a task.

online docs

Link to this function get_actions_on_players_in_segment_task_instance(params)
get_actions_on_players_in_segment_task_instance(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Get information about a ActionsOnPlayersInSegment task instance.

online docs

Link to this function get_cloud_script_task_instance(params)
get_cloud_script_task_instance(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Get detail information about a CloudScript task instance.

online docs

Link to this function get_task_instances(params)
get_task_instances(map()) :: {:ok, map()} | {:error, String.t()}

Query for task instances by task, status, or time range.

online docs

Link to this function get_tasks(params)
get_tasks(map()) :: {:ok, map()} | {:error, String.t()}

Get definition information on a specified task or all tasks within a title.

online docs

Link to this function run_task(params)
run_task(map()) :: {:ok, map()} | {:error, String.t()}

Run a task immediately regardless of its schedule.

online docs

Link to this function update_task(params)
update_task(map()) :: {:ok, map()} | {:error, String.t()}

Update an existing task.

online docs