-
Notifications
You must be signed in to change notification settings - Fork 1
profile
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_profile_get_profiles
- elements_profile_create_profile
- elements_profile_update_profile
- elements_profile_deactivate_profile
- elements_profile_get_current_profile
- elements_profile_get_profile
- elements_profile_update_profile_image
- elements_profile_get_profile_save_data_document_by_slot
Elements Operation: getProfiles
This function searches all users in the system and returns the metadata for all matches against the given search filter. Optionally provide before and after params to specify a time range [after, before] for last-logged-in profiles matching in that range (inclusive). If before is not specified (or a negative number is provided) but after is valid, the query will return all records successive to the given after timestamp. Similarly, if after is not specified (or a negative number is provided) but before is valid, the query will return all records preceding the given before timestamp.
Note
Search and time range parameters currently cannot be combined in the same query.
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 Function.
Syntax:
elements_profile_get_profiles(_offset=undefined, _count=undefined, _before=undefined, _after=undefined, _application=undefined, _user=undefined, _search=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _offset | Real | The offset of the first result to return in the page. |
| _count | Real | The number of results to return in the page. |
| _before | Real | The "before" date of the time range. If not specified (or a negative number is provided) but _after is valid, the query will return all records successive to the given _after timestamp. |
| _after | Real | The "after" date of the time range. if not specified (or a negative number is provided) but _before is valid, the query will return all records preceding the given _before timestamp. |
| _application | String | The name or ID of the application. |
| _user | String | The User associated with the Profile. |
| _search | String | The search filter to use. |
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsPaginationProfile | |
| _request | ElementsRequest |
Elements Operation: createProfile
Supplying the create profile request, this function will update the profile with the new information supplied in the body of the request. This will fire an event, dev.getelements.elements.service.profile.created, from the event manifest.
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 Function.
Syntax:
elements_profile_create_profile(_body=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _body | ElementsCreateProfileRequest | The body to be included in the HTTP request. |
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsProfile | |
| _request | ElementsRequest |
Elements Operation: updateProfile
Supplying an update request will attempt to update the profile. The call will return the profile as it was written to the database.
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 Function.
Syntax:
elements_profile_update_profile(_profile_id, _body=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _profile_id | String | The ID of the profile to update. |
| _body | ElementsUpdateProfileRequest | The body to be included in the HTTP request. |
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsProfile | |
| _request | ElementsRequest |
Elements Operation: deactivateProfile
This function deletes and permanently removes the Profile from the server. The server may keep some record around to preserve relationships and references, but this profile will not be accessible again until it is recreated.
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 Function.
Syntax:
elements_profile_deactivate_profile(_profile_id, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _profile_id | String | The ID of the profile to update. |
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | Undefined | |
| _request | ElementsRequest |
Elements Operation: getCurrentProfile
This function accesses a special endpoint which fetches the current Profile based on current auth credentials. This considers the currently loggged-in User as well as the Application or Application Configuration against which the User is operating. This may not be available, in which case the appropriate error is raised.
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 Function.
Syntax:
elements_profile_get_current_profile(_callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsProfile | |
| _request | ElementsRequest |
Elements Operation: getProfile
This function gets a specific profile by profile ID.
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 Function.
Syntax:
elements_profile_get_profile(_name, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _name | String | The profile name. |
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsProfile | |
| _request | ElementsRequest |
Elements Operation: updateProfileImage
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 Function.
Syntax:
elements_profile_update_profile_image(_profile_id, _body=undefined, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _profile_id | String | The ID of the profile. |
| _body | ElementsUpdateProfileImageRequest | The body to be included in the HTTP request. |
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
Triggers:
| Key | Type | Description |
|---|---|---|
| _status | Real | |
| _data | ElementsProfile | |
| _request | ElementsRequest |
Elements Operation: getProfileSaveDataDocumentBySlot
This function gets a single save data document based on Profile ID and slot. This is a convenience method which allows the client to fetch a save data based on slot and profile ID.
Syntax:
elements_profile_get_profile_save_data_document_by_slot(_profile_id, _slot, _callback=undefined)
| Argument | Type | Description |
|---|---|---|
| _profile_id | String | The Profile ID. |
| _slot | Real | The slot. |
| _callback | Function | The function - with signature (status, data, request) - that will be executed upon request completion. |
Returns:
N/A
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