-
Notifications
You must be signed in to change notification settings - Fork 1
elements_schedule
The Schedule endpoints.
This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.
- elements_create_schedule
- elements_create_schedule_event
- elements_delete_schedule
- elements_delete_schedule_event
- elements_get_schedule_by_name_or_id
- elements_get_schedule_event_by_name_or_id
- elements_get_schedule_events
- elements_get_schedule_progresses
- elements_get_schedules
- elements_update_schedule
- elements_update_schedule_event
Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The Schedule representation returned in the response body is a representation of the Schedule as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_create_schedule(_body=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _body | ElementsCreateScheduleRequest | The body to be included in the http request. |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsSchedule or Undefined | |
| _request | ElementsRequest |
Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The ScheduleEvent representation returned in the response body is a representation of the ScheduleEvent as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_create_schedule_event(_schedule_name_or_id, _body=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _body | ElementsCreateScheduleEventRequest | The body to be included in the http request. |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsScheduleEvent or Undefined | |
| _request | ElementsRequest |
Deletes a schedule by the passed in identifier
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_delete_schedule(_schedule_name_or_id, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | Any | |
| _request | ElementsRequest |
Deletes a schedule by the passed in identifier
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_delete_schedule_event(_schedule_name_or_id, _schedule_event_id, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _schedule_event_id | String | |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | Any | |
| _request | ElementsRequest |
Looks up a schedule by the passed in identifier
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_get_schedule_by_name_or_id(_schedule_name_or_id, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsSchedule or Undefined | |
| _request | ElementsRequest |
Looks up a schedule by the passed in identifier
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_get_schedule_event_by_name_or_id(_schedule_name_or_id, _schedule_event_id, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _schedule_event_id | String | |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsScheduleEvent or Undefined | |
| _request | ElementsRequest |
Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_get_schedule_events(_schedule_name_or_id, _offset=undefined, _count=undefined, _tags=undefined, _search=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _offset | Real | |
| _count | Real | |
| _tags | Array of String | |
| _search | String | |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsPaginationScheduleEvent or Undefined | |
| _request | ElementsRequest |
Fetches all current assignments to the currently logged-in profile.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_get_schedule_progresses(_schedule_name_or_id, _offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _offset | Real | |
| _count | Real | |
| _tags | Array of String | |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsPaginationProgress or Undefined | |
| _request | ElementsRequest |
Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_get_schedules(_offset=undefined, _count=undefined, _tags=undefined, _search=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _offset | Real | |
| _count | Real | |
| _tags | Array of String | |
| _search | String | |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsPaginationSchedule or Undefined | |
| _request | ElementsRequest |
Supplying a schedule, this will update the Schedule identified by the name or ID in the path with contents from the passed in request body.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_update_schedule(_schedule_name_or_id, _body=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _body | ElementsUpdateScheduleRequest | The body to be included in the http request. |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsSchedule or Undefined | |
| _request | ElementsRequest |
Supplying a schedule, this will update the ScheduleEvent identified by the name or ID in the path with contents from the passed in request body.
This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.
Syntax:
elements_update_schedule_event(_schedule_name_or_id, _schedule_event_id, _body=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _schedule_name_or_id | String | |
| _schedule_event_id | String | |
| _body | ElementsUpdateScheduleEventRequest | The body to be included in the http request. |
| _callback | Function | Callback with signature (status, data, request). |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsScheduleEvent or Undefined | |
| _request | ElementsRequest |
GameMaker 2026
- Application
- Auth
- Auth Scheme
- Blockchain
- Codegen
- Deployment
- Elements
- Elm
- Followee
- Follower
- Friend
- Health
- Index
- Inventory
- Invite
- Ios
- Item
- Large Object
- Large Object Mp
- Leaderboard
- Meta
- Metadata
- Metadata Spec
- Mission
- Mock Session
- Multi Match
- Notification
- Oidc
- Product
- Profile
- Progress
- Rank
- Receipt
- Reward Issuance
- Save Data
- Schedule
- Score
- Session
- Signup
- Steam
- User
- Verify
- Version