Schemas

This module contains the structs used by the Elements extension.

Structs

This module offers a collection of structs, which serve as custom data models for organizing and structuring data. Explore the provided structs to better understand the relationships between data elements and simplify your data manipulation tasks.


Back To Top

ElementsMetadataSpecProperty

This struct is referenced by the following structs:


Member Type Description
_name String The unique name of the field
_display_name String The display name of the field
_type String The field type
_required Real True if the field is required.
_placeholder String The placeholder description when displaying in the editor.
_default_value Struct The default description, null if left unspecified.
_properties Array of ElementsMetadataSpecProperty


Back To Top

ElementsMetadataSpec

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the schema itself.
_name String The Name of the schema.
_type String The type of the tab itself.
_properties Array of ElementsMetadataSpecProperty The tabs of the metadata spec.


Back To Top

ElementsItem

This struct is referenced by the following structs:


Member Type Description
_name String
_display_name String
_description String
_category String
_id String
_tags Array of String
_metadata_spec ElementsMetadataSpec Represents a spec for metadata.
_metadata Struct
_public_visible Real


Back To Top

ElementsUser

This struct is referenced by the following structs:


Member Type Description
_id String The user's database assigned unique ID.
_level String The user's access level.
_name String A unique name for the user.
_first_name String The user's first name
_last_name String The user's last name
_email String The user's email.
_primary_phone_nb String The user's phone number.
_linked_accounts Array of String List of linked account or auth scheme names.


Back To Top

ElementsRewardIssuance

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the issuance.
_user ElementsUser The User associated with this Profile.
_state String The state of the reward. On creation, this is automatically assigned to be ISSUED. If the current value of the state is REDEEMED, then the state is no longer allowed to be updated. This valuemay not be directly modified--the redeem DAO method should be used instead to perform the redemption process.
_context String A generic String used to uniquely identify the RewardIssuance issuance. If the RewardIssuance is created by the client, this value must be specified to prevent erroneous duplicate issuances. E.g. if the client successfully submits an issuance but fails to receive the response, the client is expected to submit a new issuance with the same context string. Similarly, the client application should have safeguards in place in the event of a crash to prevent duplicate submissions: e.g. ensuring that the context string is unchanged when performing multiple issuances of the same RewardIssuance. If the RewardIssuance is generated by the server, this will be defined automatically. The context cannot be updated after creation. Note that an context defined via the API should not begin with 'server.' as that is a protected namespace.
_type String Defines whether multiple issuances for the given user+reward+context may occur. If the type is set to NON_PERSISTENT, at most one ISSUED RewardIssuance may exist in the server at a time for a given user and context. If the type is set to PERSISTENT, at most one ISSUED or REDEEMED RewardIssuance may exist in the server for a given user and context, i.e. once a PERSISTENT RewardIssuance has been submitted, a new one may never be submitted and will be rejected by the server. Note that this value cannot be updated. By default, this will be set to NON_PERSISTENT.
_item ElementsItem The Item to be issued upon redemption.
_item_quantity Real The amount of Items to be set/added to the InventoryItem upon redemption.
_source String Identifies the source of the issuance, e.g. 'Client', 'IAP', 'Leaderboard'. This may be specified manually by the client if desired. Note that this value cannot be updated.
_metadata Struct Metadata for the issuance. May be optionally defined by the client on creation. If the source is a server-side value, then a predefined structure will always be followed that provides additional information as to the source of the issuance (e.g. mission progress/step information).
_tags Array of String The tags used to categorize this Reward Issuance.
_expiration_timestamp Real Optionally define when the issuance should expire. This value may be updated to extend when the expiration occurs. When set, this value must be greater than the current time on the server.Note that the record may not actually be deleted for up to sixty seconds after the time noted in thetimestamp.
_uuid String Internal unique identifier generated and assigned on creation.


Back To Top

ElementsCreateAppleIapReceipt

This struct is referenced by the following functions:


Member Type Description
_receipt_data String The base64-encoded string of the raw IAP receipt.
_create_apple_iap_receipt_environment String


Back To Top

ElementsApplicationConfiguration

This struct is referenced by the following structs:


Member Type Description
_id String The database assigned ID for the application configuration.
_name String The application-configuration specific unique ID. Unique per application per category.
_type String The fully-qualified Java type of ApplicationConfiguration.
_description String
_parent ElementsApplication


Back To Top

ElementsApplication

This struct is referenced by the following structs:


Member Type Description
_name String
_id String
_description String
_git_branch String
_script_repo_url String
_http_documentation_url String
_http_documentation_ui_url String
_http_tunnel_endpoint_url String
_attributes Struct
_application_configuration ElementsApplicationConfiguration


Back To Top

ElementsPaginationApplicationConfiguration


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsApplicationConfiguration


Back To Top

ElementsCreateApplicationRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_description String
_attributes Struct


Back To Top

ElementsPaginationApplication


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsApplication


Back To Top

ElementsUpdateApplicationRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_description String
_attributes Struct


Back To Top

ElementsFacebookApplicationConfiguration

This struct is referenced by the following functions:


Member Type Description
_id String The database assigned ID for the application configuration.
_name String The application-configuration specific unique ID. Unique per application per category.
_type String The fully-qualified Java type of ApplicationConfiguration.
_description String
_parent ElementsApplication
_application_id String The AppID as it appears in the Facebook Developer Console
_application_secret String The App Secret as it appears in the Facebook Developer Console
_builtin_application_permissions Array of String The set of built-in permissions connected clients will need to request.


Back To Top

ElementsFirebaseApplicationConfiguration

This struct is referenced by the following functions:


Member Type Description
_id String The database assigned ID for the application configuration.
_name String The application-configuration specific unique ID. Unique per application per category.
_type String The fully-qualified Java type of ApplicationConfiguration.
_description String
_parent ElementsApplication
_project_id String The contents of the serviceAccountCredentials.json file.
_service_account_credentials String The contents of the serviceAccountCredentials.json file.


Back To Top

ElementsProductBundleReward

This struct is referenced by the following structs:


Member Type Description
_item_id String The id of the item to be rewarded.
_quantity Real The quantity of the item to be rewarded.


Back To Top

ElementsProductBundle

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
_product_id String The platform-specific unique SKU/product identifier that, when purchased, will result in the items in this product bundle to be issued to the user.
_product_bundle_rewards Array of ElementsProductBundleReward The list of product bundle rewards that will be issued to the user upon purchase.
_display Real Whether or not the frontend should display this product bundle to end users.
_display_name String The title of the product bundle to display to end users.
_description String The description of the product bundle to display to end users.
_metadata Struct Application-specific metadata.


Back To Top

ElementsGooglePlayApplicationConfiguration

This struct is referenced by the following functions:


Member Type Description
_id String The database assigned ID for the application configuration.
_name String The application-configuration specific unique ID. Unique per application per category.
_type String The fully-qualified Java type of ApplicationConfiguration.
_description String
_parent ElementsApplication
_application_id String
_json_key Struct
_product_bundles Array of ElementsProductBundle The list of product bundles that may be rewarded upon successful IAP transactions.


Back To Top

ElementsIosApplicationConfiguration

This struct is referenced by the following functions:


Member Type Description
_id String The database assigned ID for the application configuration.
_name String The application-configuration specific unique ID. Unique per application per category.
_type String The fully-qualified Java type of ApplicationConfiguration.
_description String
_parent ElementsApplication
_application_id String
_product_bundles Array of ElementsProductBundle The list of product bundles that may be rewarded upon successful IAP transactions.


Back To Top

ElementsElementServiceReference

This struct is referenced by the following structs:


Member Type Description
_element_name String The name of the Element to reference.
_service_type String Specifies the type of the service within the Element. May be null.
_service_name String Specifies the name of the service within the Element. May be null.


Back To Top

ElementsCallbackDefinition

This struct is referenced by the following structs:


Member Type Description
_method String Specifies the method to invoke.
_service ElementsElementServiceReference Describes the matchmaker (dev.getelements.elements.sdk.dao.Matchmaker) to use for this configuration.


Back To Top

ElementsMatchmakingApplicationConfiguration

This struct is referenced by the following functions:


Member Type Description
_id String The database assigned ID for the application configuration.
_name String The application-configuration specific unique ID. Unique per application per category.
_type String The fully-qualified Java type of ApplicationConfiguration.
_description String
_parent ElementsApplication
_success ElementsCallbackDefinition Defines a script method and a module to invoke.
_matchmaker ElementsElementServiceReference Describes the matchmaker (dev.getelements.elements.sdk.dao.Matchmaker) to use for this configuration.
_max_profiles Real The maximum number of profiles that can be matched in a single match.
_metadata Struct The metadata for this matchmaking configuration. This will be copied to the match when it is created.
_metadata_spec ElementsMetadataSpec Represents a spec for metadata.


Back To Top

ElementsPSNApplicationConfiguration

This struct is referenced by the following functions:


Member Type Description
_id String The database assigned ID for the application configuration.
_name String The application-configuration specific unique ID. Unique per application per category.
_type String The fully-qualified Java type of ApplicationConfiguration.
_description String
_parent ElementsApplication
_np_identifier String
_client_secret String


Back To Top

ElementsAuthScheme

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the auth scheme.
_audience String A unique name used to identify the scheme within the instance of Elements.
_public_key String A base-64 encoded string representing an x509 encoded public key.
_algorithm String The digital signature matching the public key format.
_user_level String The highest permitted user level this particular scheme will authorize.
_tags Array of String The tags used to tag this auth scheme.
_allowed_issuers Array of String A list of issuers allowed to use this scheme.


Back To Top

ElementsCreateAuthSchemeResponse


Member Type Description
_scheme ElementsAuthScheme The full JSON response as described in AuthScheme
_public_key String The Base64 public key that was either given or generated during creation. See https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/spec/X509EncodedKeySpec.html for details on the specifics of the format.
_private_key String The Base64 public key that was either given or generated during creation. See https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/spec/PKCS8EncodedKeySpec.html for details on the specifics of the format.


Back To Top

ElementsCreateAuthSchemeRequest

This struct is referenced by the following functions:


Member Type Description
_audience String The JWT audience for the scheme. Must be unique.
_algorithm String
_user_level String The highest permitted user level this particular scheme will authorize.
_tags Array of String A list of tags used to index the auth scheme.
_allowed_issuers Array of String The list of issuers allowed to use this scheme.
_public_key String The Base64 public key that was either given or generated during creation. See https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/spec/X509EncodedKeySpec.html for details on the specifics of the format.


Back To Top

ElementsPaginationAuthScheme


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsAuthScheme


Back To Top

ElementsUpdateAuthSchemeResponse


Member Type Description
_public_key String The Base64 public key that was either given or generated during creation. See https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/spec/X509EncodedKeySpec.html for details on the specifics of the format.
_scheme ElementsAuthScheme The full JSON response as described in AuthScheme
_private_key String The Base64 public key that was either given or generated during creation. See https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/spec/PKCS8EncodedKeySpec.html for details on the specifics of the format.


Back To Top

ElementsUpdateAuthSchemeRequest

This struct is referenced by the following functions:


Member Type Description
_audience String The JWT audience for the scheme. Must be unique.
_algorithm String The algorithm that Elements will use with the supplied key.
_user_level String The highest permitted user level this particular scheme will authorize.
_tags Array of String The list of tags for tagging the auth scheme.
_allowed_issuers Array of String The list of issuers allowed to use this scheme.
_regenerate Real If set to true, Elements will regenerate the key and pubKey must be null or omitted
_public_key String The Base64 public key that was either given or generated during creation. See https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/spec/X509EncodedKeySpec.html for details on the specifics of the format.


Back To Top

ElementsLargeObjectReference

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the LargeObject.
_url String The URL where the binary contents of the LargeObject may be read.
_mime_type String The MIME type of the LargeObject.
_state String Current state of the LargeObject.
_last_modified String Date of last modification


Back To Top

ElementsProfile

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the profile itself.
_user ElementsUser The User associated with this Profile.
_application ElementsApplication
_display_name String A non-unique display name for this profile.
_image_url String A URL to the image of the profile. (ie the User's Avatar).
_image_object ElementsLargeObjectReference Image object stored in EL large objects storage.
_metadata Struct An object containing arbitrary player metadata as key-value pairs.
_last_login Real The last time this profile has been logged in by the user.


Back To Top

ElementsSession

This struct is referenced by the following structs:


Member Type Description
_user ElementsUser The User associated with this Profile.
_profile ElementsProfile
_application ElementsApplication
_expiry Real


Back To Top

ElementsSessionCreation


Member Type Description
_session_secret String The Session Secret to pass to subsequent requests through headers.
_session ElementsSession The Session object generated by the request.


Back To Top

ElementsOAuth2SessionRequest

This struct is referenced by the following functions:


Member Type Description
_scheme_id String The OAuth2 scheme ID to use.
_request_parameters Struct The request parameters to be used in the token validation request. This should adhere to any params marked as fromClient in the auth scheme.
_request_headers Struct The request headers to be used in the token validation request. This should adhere to any headers marked as fromClient in the auth scheme.
_profile_id String The profile ID to assign to the session.
_profile_selector String A query string to select the profile to use. NOTE: This will not be run if a profileId is specified.


Back To Top

ElementsOAuth2RequestKeyValue

This struct is referenced by the following structs:


Member Type Description
_key String The key.
_value String The value.
_from_client Real If this value should be received from the client, or predefined and stored in the DB.


Back To Top

ElementsOAuth2AuthScheme

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the auth scheme.
_name String A unique name used to identify the scheme within the instance of Elements. If using the same OAuth2 provider (e.g. Steam), it is recommended to suffix the name for each application when using multitenancy, e.g. steam_game1, steam_game2, etc.
_validation_url String The URL to send the user token validation request to.
_headers Array of ElementsOAuth2RequestKeyValue The headers required for the validation request.
_params Array of ElementsOAuth2RequestKeyValue The query parameters required for the validation request.
_response_id_mapping String Determines how to map the user id in the response. For example "response.params.steamid"


Back To Top

ElementsCreateOrUpdateOAuth2AuthSchemeResponse


Member Type Description
_scheme ElementsOAuth2AuthScheme The full JSON response as described in AuthScheme


Back To Top

ElementsCreateOrUpdateOAuth2AuthSchemeRequest

This struct is referenced by the following functions:


Member Type Description
_id String The unique ID of the auth scheme.
_name String A unique name used to identify the scheme within the instance of Elements. If using the same OAuth2 provider (e.g. Steam), it is recommended to suffix the name for each application when using multitenancy, e.g. steam_game1, steam_game2, etc.
_validation_url String The URL to send the user token validation request to.
_headers Array of ElementsOAuth2RequestKeyValue The headers required for the validation request.
_params Array of ElementsOAuth2RequestKeyValue The query parameters required for the validation request.
_response_id_mapping String Determines how to map the user id in the response. For example "response.params.steamid"


Back To Top

ElementsPaginationOAuth2AuthScheme


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsOAuth2AuthScheme


Back To Top

ElementsOidcSessionRequest

This struct is referenced by the following functions:


Member Type Description
_jwt String The JWT to parse
_profile_id String The profile ID to assign to the session.
_profile_selector String A query string to select the profile to use. NOTE: This will not be run if a profileId is specified.


Back To Top

ElementsJWK

This struct is referenced by the following structs:


Member Type Description
_alg String Algorithm (e.g. RS256)
_kid String Key id (unique to issuer)
_kty String Key type (e.g. RSA)
_use String The intended use (e.g. sig)
_e String Base64url encoded exponent
_n String Pub key modulus


Back To Top

ElementsOidcAuthScheme

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the auth scheme.
_issuer String A unique name used to identify the scheme within the instance of Elements. When validating from an external source (e.g. Google or Apple SSO), must match the 'iss' property of the decoded JWT.
_keys Array of ElementsJWK A set of JWKs containing the keys required to validate JWT signatures.
_name String The unique name of the auth scheme.
_keys_url String The URL for the JWK data. Will attempt to refresh keys if the kid cannot be found in the collection.
_media_type String The JWK format. Defaults to application/json


Back To Top

ElementsCreateOrUpdateOidcAuthSchemeResponse


Member Type Description
_scheme ElementsOidcAuthScheme The full JSON response as described in AuthScheme


Back To Top

ElementsCreateOrUpdateOidcAuthSchemeRequest

This struct is referenced by the following functions:


Member Type Description
_id String The unique ID of the auth scheme.
_issuer String A unique name used to identify the scheme within the instance of Elements. When validating from an external source (e.g. Google or Apple SSO), must match the 'iss' property of the decoded JWT.
_keys Array of ElementsJWK A set of JWKs containing the keys required to validate JWT signatures.
_keys_url String The URL for the JWK data. Will attempt to refresh keys if the kid cannot be found in the collection.
_media_type String The JWK format. Defaults to application/json


Back To Top

ElementsPaginationOidcAuthScheme


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsOidcAuthScheme


Back To Top

ElementsVaultKey

This struct is referenced by the following structs:


Member Type Description
_algorithm String Specifies the private key encryption algorithm used to secure the vault.
_public_key String The public key portion of the vault key.
_private_key String The private key portion of the vault key.
_encrypted Real The flag to indicate if the key is encrypted or not.
_encryption Struct The Vault's encryption metadata. This is specific to the encryption type used.


Back To Top

ElementsVault

This struct is referenced by the following structs:


Member Type Description
_id String The system assigned unique id of the vault.
_user ElementsUser The User associated with this Profile.
_display_name String The display name given to this vault.
_key ElementsVaultKey The Vault's key. The vault secures each vault with this key.


Back To Top

ElementsSmartContract

This struct is referenced by the following structs:


Member Type Description
_id String The Elements database id of the contract.
_name String The unique symbolic name of the smart contract.
_display_name String The name given to this contract for display purposes.
_addresses Struct The addresses of the contract from the blockchain. Depending on the network or protocol this may have several meanings. For example, this may be the script has for the Ethereum network.
_vault ElementsVault
_metadata Struct Any metadata for this contract.


Back To Top

ElementsSmartContractAddress


Member Type Description
_address String


Back To Top

ElementsCreateSmartContractRequest

This struct is referenced by the following functions:


Member Type Description
_name String The unique symbolic name of the smart contract.
_display_name String The name given to this contract for display purposes.
_addresses Struct The address of the contract from the blockchain. Depending on the network or protocol this may have several meanings and vary depending on the specific API or network.
_vault_id String The Elements database id of the wallet containing the default account to be used for contract related requests.
_metadata Struct Any metadata for this contract.


Back To Top

ElementsPaginationSmartContract


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsSmartContract


Back To Top

ElementsUpdateSmartContractRequest

This struct is referenced by the following functions:


Member Type Description
_name String The unique symbolic name of the smart contract.
_display_name String The name given to this contract for display purposes.
_addresses Struct The address of the contract from the blockchain. Depending on the network or protocol this may have several meanings and vary depending on the specific API or network.
_vault_id String The Elements database id of the wallet containing the default account to be used for contract related requests.
_metadata Struct Any metadata for this contract.


Back To Top

ElementsCreateVaultRequest

This struct is referenced by the following functions:


Member Type Description
_user_id String The elements-defined user ID to own the vault.
_display_name String A user-defined name for the vault. This is used simply for the user's reference and has no bearing onthe vault's functionality.
_passphrase String The passphrase used to to encrypt the vault. If empty, then the vault will not be encrypted. Some configurations may opt to disallow encryption entirely.
_algorithm String The encryption algorithm used to secure the vault. Once crated, a vault will contains a private/public key pair which will be used to encrypt the wallets within the vault.


Back To Top

ElementsPaginationVault


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsVault


Back To Top

ElementsUpdateVaultRequest

This struct is referenced by the following functions:


Member Type Description
_display_name String A user-defined name for the vault. This is used simply for the user's reference and has no bearing onthe vault's functionality.
_user_id String The elements-defined user ID to own the vault.
_passphrase String The current passphrase for the vault. If left null, no updates to the passphrase will be made. If not-null, then the new password must also not be null.
_new_passphrase String The updated passphrase for the vault. If left null, no updates to the passphrase will be made. If not-null, then the password must also not be null.


Back To Top

ElementsWalletAccount

This struct is referenced by the following structs:


Member Type Description
_address String The Wallet Address - id public identity. Required.
_private_key String The Wallet Account - id private identity. May be null if the wallet is for receive only.
_encrypted Real Indicates if this identity is encrypted.


Back To Top

ElementsWallet

This struct is referenced by the following structs:


Member Type Description
_id String The system assigned unique id of the wallet.
_user ElementsUser The User associated with this Profile.
_vault ElementsVault
_display_name String The name given to this wallet.
_api String The protocol used wiht this wallet.
_networks Array of String The networks associated with this wallet.
_accounts Array of ElementsWalletAccount The list of account pairs included in this wallet.
_preferred_account Real The default account. Must not be larger than the count of identities.


Back To Top

ElementsCreateWalletRequestAccount

This struct is referenced by the following structs:


Member Type Description
_address String The Wallet Address - id public identity. Must be null for generated wallets.
_generate Real Flag which indicates if the account should be generated or imported.
_private_key String The Wallet Account - id private identity. May be null if the wallet is for receive only.


Back To Top

ElementsCreateWalletRequest

This struct is referenced by the following functions:


Member Type Description
_display_name String A user-defined name for the wallet. This is used simply for the user's reference and has no bearing onthe wallet's functionality.
_api String The protocol of this wallet. Once set, this cannot be unset.
_networks Array of String The networks associated with this wallet. All must support the Wallet's protocol.
_accounts Array of ElementsCreateWalletRequestAccount
_preferred_account Real The default identity. Must not be larger than the count of identities.


Back To Top

ElementsPaginationWallet


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsWallet


Back To Top

ElementsUpdateWalletRequest

This struct is referenced by the following functions:


Member Type Description
_networks Array of String The networks associated with this wallet. All must support the Wallet's protocol.
_display_name String The new display name of the wallet.
_preferred_account Real The default identity. Must not be larger than the count of identities.


Back To Top

ElementsDeployment

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the deployment itself.
_version String The deployment version. Allows for overriding versions with new content.
_revision String The revision that this deployment points to.
_application ElementsApplication


Back To Top

ElementsCreateDeploymentRequest

This struct is referenced by the following functions:


Member Type Description
_version String
_revision String


Back To Top

ElementsPaginationDeployment


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsDeployment


Back To Top

ElementsUpdateDeploymentRequest

This struct is referenced by the following functions:


Member Type Description
_revision String


Back To Top

ElementsCodegenRequest

This struct is referenced by the following functions:


Member Type Description
_element_spec_url String The URL for the Element OpenApi spec. Usually /app/rest/elementName/openapi.json
_language String The target language that you want to generate the code to.
_package_name String The package name to set the generated code to. E.g. com.mycompany.mygame.Elements
_options String Any additional options that you want to pass to the generator


Back To Top

ElementsFilterRegistration


Member Type Description
_servlet_name_mappings Array of String
_url_pattern_mappings Array of String
_name String
_class_name String
_init_parameters Struct


Back To Top

ElementsTaglibDescriptor

This struct is referenced by the following structs:


Member Type Description
_taglib_uri String
_taglib_location String


Back To Top

ElementsJspPropertyGroupDescriptor

This struct is referenced by the following structs:


Member Type Description
_buffer String
_url_patterns Array of String
_el_ignored String
_is_xml String
_error_on_el_not_found String
_page_encoding String
_scripting_invalid String
_include_preludes Array of String
_include_codas Array of String
_default_content_type String
_trim_directive_whitespaces String
_error_on_undeclared_namespace String
_deferred_syntax_allowed_as_literal String


Back To Top

ElementsJspConfigDescriptor

This struct is referenced by the following structs:


Member Type Description
_taglibs Array of ElementsTaglibDescriptor
_jsp_property_groups Array of ElementsJspPropertyGroupDescriptor


Back To Top

ElementsSessionCookieConfig

This struct is referenced by the following structs:


Member Type Description
_path String
_domain String
_name String
_attributes Struct
_comment String
_http_only Real
_secure Real
_max_age Real


Back To Top

ElementsServletContext

This struct is referenced by the following structs:


Member Type Description
_class_loader Struct
_major_version Real
_minor_version Real
_context_path String
_server_info String
_attribute_names Struct
_servlet_context_name String
_filter_registrations Struct
_session_cookie_config ElementsSessionCookieConfig
_jsp_config_descriptor ElementsJspConfigDescriptor
_virtual_server_name String
_session_timeout Real
_init_parameter_names Struct
_effective_major_version Real
_effective_minor_version Real
_servlet_registrations Struct
_session_tracking_modes Array of String
_default_session_tracking_modes Array of String
_request_character_encoding String
_response_character_encoding String
_effective_session_tracking_modes Array of String


Back To Top

ElementsServletConfig


Member Type Description
_servlet_name String
_servlet_context ElementsServletContext
_init_parameter_names Struct


Back To Top

ElementsServletRegistration


Member Type Description
_mappings Array of String
_run_as_role String
_name String
_class_name String
_init_parameters Struct


Back To Top

ElementsPaginationProfile


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsProfile


Back To Top

ElementsCreateFollowerRequest

This struct is referenced by the following functions:


Member Type Description
_followed_id String The profile id which to follow.


Back To Top

ElementsFriend

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the friendship.
_user ElementsUser The User associated with this Profile.
_friendship String The friendship type.
_profiles Array of ElementsProfile The profiles which are associated with the friend user.


Back To Top

ElementsPaginationFriend


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsFriend


Back To Top

ElementsCreateItemRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_display_name String
_description String
_category String
_tags Array of String
_metadata_spec_id String
_metadata Struct
_public_visible Real
_metadata_spec String


Back To Top

ElementsPaginationItem


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsItem


Back To Top

ElementsUpdateItemRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_display_name String
_description String
_tags Array of String
_metadata_spec ElementsMetadataSpec Represents a spec for metadata.
_metadata Struct
_public_visible Real


Back To Top

ElementsCreateGooglePlayIapReceipt

This struct is referenced by the following functions:


Member Type Description
_package_name String The package name of the app. Note that this may be different from the applicationId/uniqueIdentifier which is why it should be provided with the request.
_product_id String The product id purchased by the user, e.g. com.namazustudios.example_app.pack_10_coins.
_purchase_token String The token issued to the user upon successful Google Play purchase transaction.


Back To Top

ElementsBuildIndexRequest

This struct is referenced by the following functions:


Member Type Description
_plan Real Set to true to plan the index building.
_to_index Array of String Set to true to perform the index building.


Back To Top

ElementsIndexMetadataObject

This struct is referenced by the following structs:


Member Type Description
_identifier Struct


Back To Top

ElementsIndexPlanStepObject

This struct is referenced by the following structs:


Member Type Description
_description String
_operation String
_index_metadata ElementsIndexMetadataObject


Back To Top

ElementsIndexPlanObject

This struct is referenced by the following structs:


Member Type Description
_id String
_state String
_steps ElementsIndexPlanStepObject


Back To Top

ElementsPaginationIndexPlanObject


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsIndexPlanObject


Back To Top

ElementsInventoryItem

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the inventory item itself.
_user ElementsUser The User associated with this Profile.
_item ElementsItem The Item to be issued upon redemption.
_quantity Real The quantity of the Item in inventory
_priority Real The priority of this Item grouping in inventory (for stacked/packaged inventory support)


Back To Top

ElementsAdvancedInventoryItemQuantityAdjustment

This struct is referenced by the following functions:


Member Type Description
_user_id String The User whose inventory to modify.ß
_quantity_delta Real The delta to be applied to the inventory item quantity (positive or negative)
_priority Real The priority slot for the item.


Back To Top

ElementsCreateAdvancedInventoryItemRequest

This struct is referenced by the following functions:


Member Type Description
_user_id String The User ID
_item_id String The item to reference.
_quantity Real The quantity of the Item in inventory
_priority Real The priority slot for the item.


Back To Top

ElementsPaginationInventoryItem


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsInventoryItem


Back To Top

ElementsUpdateInventoryItemRequest

This struct is referenced by the following functions:


Member Type Description
_quantity Real The quantity of the Item in inventory


Back To Top

ElementsDistinctInventoryItem

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the inventory item itself.
_item ElementsItem The Item to be issued upon redemption.
_user ElementsUser The User associated with this Profile.
_profile ElementsProfile
_metadata Struct


Back To Top

ElementsCreateDistinctInventoryItemRequest

This struct is referenced by the following functions:


Member Type Description
_item_id String The digital goods item id.
_user_id String The id of the User owning this inventory item id.
_profile_id String The the profileid of hte Profile owning this inventory item.
_metadata Struct


Back To Top

ElementsPaginationDistinctInventoryItem


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsDistinctInventoryItem


Back To Top

ElementsUpdateDistinctInventoryItemRequest

This struct is referenced by the following functions:


Member Type Description
_user_id String The id of the User owning this inventory item id.
_profile_id String The the profile id of hte Profile owning this inventory item.
_metadata Struct


Back To Top

ElementsSimpleInventoryItemQuantityAdjustment

This struct is referenced by the following functions:


Member Type Description
_user_id String The User whose inventory to modify.ß
_quantity_delta Real The delta to be applied to the inventory item quantity (positive or negative)


Back To Top

ElementsCreateSimpleInventoryItemRequest

This struct is referenced by the following functions:


Member Type Description
_user_id String The User ID
_item_id String The item to reference.
_quantity Real The quantity of the Item in inventory


Back To Top

ElementsPhoneMatchedInvitation

This struct is referenced by the following structs:


Member Type Description
_phone_number String Phone number
_profile_ids Array of String The list of profile Ids that phone was matched


Back To Top

ElementsInviteViaPhonesResponse


Member Type Description
_matched Array of ElementsPhoneMatchedInvitation The list of objects representing matched phone numbers


Back To Top

ElementsInviteViaPhonesRequest

This struct is referenced by the following functions:


Member Type Description
_phone_numbers Array of String The list of phone numbers


Back To Top

ElementsSubjects

This struct is referenced by the following structs:


Member Type Description
_users Array of ElementsUser Users which may perform the operations.
_profiles Array of ElementsProfile Profiles, which owners may perform the operations.
_wildcard Real Flag to check who may perform the operations. True if all users may access the object.


Back To Top

ElementsAccessPermissions

This struct is referenced by the following structs:


Member Type Description
_read ElementsSubjects Subjects allowed to delete
_write ElementsSubjects Subjects allowed to delete
_delete ElementsSubjects Subjects allowed to delete


Back To Top

ElementsLargeObject


Member Type Description
_id String The unique ID of the LargeObject.
_path String The path to the file in the underlying bucket.
_access_permissions ElementsAccessPermissions Permission associated with LargeObject.
_url String The URL where the binary contents of the LargeObject may be read. May be null, since Path param or Id is pointer for object.
_mime_type String The MIME type of the LargeObject.
_state String Current state of large object
_last_modified String Date of last modification


Back To Top

ElementsContentDisposition

This struct is referenced by the following structs:


Member Type Description
_type String
_parameters Struct
_file_name String
_creation_date String
_modification_date String
_read_date String
_size Real


Back To Top

ElementsMediaType

This struct is referenced by the following structs:


Member Type Description
_type String
_subtype String
_parameters Struct
_wildcard_type Real
_wildcard_subtype Real


Back To Top

ElementsMultiPart

This struct is referenced by the following structs:


Member Type Description
_content_disposition ElementsContentDisposition
_entity Struct
_headers Struct
_media_type ElementsMediaType
_message_body_workers Struct
_parent ElementsMultiPart
_providers Struct
_body_parts Array of ElementsBodyPart
_parameterized_headers Struct


Back To Top

ElementsBodyPart

This struct is referenced by the following structs:


Member Type Description
_content_disposition ElementsContentDisposition
_entity Struct
_headers Struct
_media_type ElementsMediaType
_message_body_workers Struct
_parent ElementsMultiPart
_providers Struct
_parameterized_headers Struct


Back To Top

ElementsFormDataContentDisposition

This struct is referenced by the following structs:


Member Type Description
_type String
_parameters Struct
_file_name String
_creation_date String
_modification_date String
_read_date String
_size Real
_name String


Back To Top

ElementsFormDataBodyPart


Member Type Description
_content_disposition ElementsContentDisposition
_entity Struct
_headers Struct
_media_type ElementsMediaType
_message_body_workers Struct
_parent ElementsMultiPart
_providers Struct
_name String
_value String
_content Struct
_file_name String
_simple Real
_form_data_content_disposition ElementsFormDataContentDisposition
_parameterized_headers Struct


Back To Top

ElementsMultivaluedMapStringParameterizedHeader


Member Type Description
_empty Real


Back To Top

ElementsMultivaluedMapStringString


Member Type Description
_empty Real


Back To Top

ElementsParameterizedHeader


Member Type Description
_value String
_parameters Struct


Back To Top

ElementsSubjectRequest

This struct is referenced by the following structs:


Member Type Description
_user_ids Array of String A List of all UserIds which can operate against the LargeObject.
_profile_ids Array of String A List of all ProfileIds which can operate against the LargeObject.
_wildcard Real Flag to check who may perform the operation. If true, all anonymous users may perform the operation.


Back To Top

ElementsCreateLargeObjectRequest

This struct is referenced by the following functions:


Member Type Description
_mime_type String The MIME type associated with the object.
_read ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.
_write ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.
_delete ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.


Back To Top

ElementsCreateLargeObjectFromUrlRequest

This struct is referenced by the following functions:


Member Type Description
_mime_type String The MIME type associated with the object.
_read ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.
_write ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.
_delete ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.
_file_url String List with image URLs


Back To Top

ElementsUpdateLargeObjectRequest

This struct is referenced by the following functions:


Member Type Description
_mime_type String The MIME type associated with the object.
_read ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.
_write ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.
_delete ElementsSubjectRequest Specifies the Subjects which can delete the LargeObject.


Back To Top

ElementsLeaderboard

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
_name String The name of the leaderboard. This must be unique across all leaderboards.
_time_strategy_type String The time strategy for the leaderboard. Current options are ALL_TIME and EPOCHAL.
_score_strategy_type String The score strategy for the leaderboard. Current options are OVERWRITE_IF_GREATER and ACCUMULATE.
_title String The user-presentable name or title for for the leaderboard.
_score_units String The units-of measure for the score type of the leaderboard.
_id String
_first_epoch_timestamp Real The time at which the leaderboard epoch intervals should begin (in ms). If null, then the leaderboard is all-time and not epochal. During creation, if this value is provided, then epochInterval must also be provided.
_epoch_interval Real The duration for a leaderboard epoch interval (in ms). If null, then the leaderboard is all-time and not epochal. During creation, if this value is provided, then firstEpochTimestamp must also be provided.


Back To Top

ElementsPaginationLeaderboard


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsLeaderboard


Back To Top

ElementsScore

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
_id String The ID of the Score
_profile ElementsProfile
_creation_timestamp Real The time at which the score was created on the server.
_leaderboard_epoch Real The epoch to which the score belongs for the associated leaderboard. By convention, if the leaderboard is all-time, this value will be set to zero.
_point_value Real The point value of the score.
_score_units String The the units of measure for the points. For example, if the points in the game were called "coins" instead of "points" this would be used to designate as such in the UI.


Back To Top

ElementsRank

This struct is referenced by the following structs:


Member Type Description
_score ElementsScore
_position Real The position of the associated score in the result set.


Back To Top

ElementsPaginationRank


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsRank


Back To Top

ElementsRankRow

This struct is referenced by the following structs:


Member Type Description
_profile_id String The profile ID of the user who holds this rank.
_profile_display_name String The profile display name of the user who holds this rank.
_profile_image_url String The profile image url of the user who holds this rank.
_last_login Real The last login.
_id String The ID of the Score
_position Real The position of the associated score in the result set.
_point_value Real The point value of the score.
_score_units String The the units of measure for the points. For example, if the points in the game were called "coins" instead of "points" this would be used to designate as such in the UI.
_creation_timestamp Real The time at which the score was created on the server.
_leaderboard_epoch Real The epoch to which the score belongs for the associated leaderboard. By convention, if the leaderboard is all-time, this value will be set to zero.


Back To Top

ElementsTabulationRankRow


Member Type Description
_rows Array of ElementsRankRow


Back To Top

ElementsMatch

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
_scheme String The scheme to use when matching with other players.
_player ElementsProfile
_id String The unique ID of the match.
_scope String An optional scope for the match. For example, if the match were part of a tournament, it could be scoped to the unique ID of the tournament.
_opponent ElementsProfile
_last_updated_timestamp Real The time of the last modification of the match.
_game_id String The system-assigned game ID of the match. Null until the match is successfully made.
_metadata Struct Additional arbitrary metadata that is attached to the match.


Back To Top

ElementsPaginationMatch


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsMatch


Back To Top

ElementsMetadata

This struct is referenced by the following structs:


Member Type Description
_id String The metadata object's database assigned unique ID.
_name String A unique name for the metadata object.
_metadata Struct An object containing the metadata payload as key-value pairs.
_access_level String The minimum level of access required to view this metadata.
_metadata_spec ElementsMetadataSpec Represents a spec for metadata.


Back To Top

ElementsCreateMetadataRequest

This struct is referenced by the following functions:


Member Type Description
_name String A unique name for the metadata object.
_metadata Struct An object containing the metadata payload as key-value pairs.
_metadata_spec ElementsMetadataSpec Represents a spec for metadata.
_access_level String The minimum level of access required to view this metadata.


Back To Top

ElementsPaginationMetadata


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsMetadata


Back To Top

ElementsUpdateMetadataRequest

This struct is referenced by the following functions:


Member Type Description
_metadata Struct An object containing the metadata payload as key-value pairs.
_metadata_spec ElementsMetadataSpec Represents a spec for metadata.
_access_level String The minimum level of access required to view this metadata.


Back To Top

ElementsReward

This struct is referenced by the following structs:


Member Type Description
_item ElementsItem The Item to be issued upon redemption.
_quantity Real The quantity of the Item that is rewarded
_metadata Struct


Back To Top

ElementsStep

This struct is referenced by the following structs:


Member Type Description
_display_name String The display name for the step
_description String The description of the step
_count Real The number of times the step must be completed to receive the reward(s)
_rewards Array of ElementsReward The reward(s) that will be granted upon completion
_metadata Struct The metadata for this step


Back To Top

ElementsMission

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the mission
_name String The name of the mission
_display_name String The display name for the mission
_description String The description of the mission
_tags Array of String The tags used to categorize this mission
_steps Array of ElementsStep The steps that constitute the mission (may be null if finalRepeatStep is specified)
_final_repeat_step ElementsStep The final repeating step (may be null if step(s) are specified)
_metadata Struct The metadata for this mission


Back To Top

ElementsPaginationMission


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsMission


Back To Top

ElementsProgressMissionInfo

This struct is referenced by the following structs:


Member Type Description
_id String The id of the mission
_name String The name of the mission
_display_name String The display name for the mission
_description String The description of the mission
_steps Array of ElementsStep The steps that constitute the mission (may be null if finalRepeatStep is specified)
_final_repeat_step ElementsStep The final repeating step (may be null if step(s) are specified)
_tags Array of String The tags used to categorize this mission
_metadata Struct The metadata for this mission


Back To Top

ElementsSchedule

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the schedule.
_name String The unique name of the schedule.
_display_name String
_description String The description for this schedule.


Back To Top

ElementsScheduleEvent

This struct is referenced by the following structs:


Member Type Description
_id String
_schedule ElementsSchedule
_missions Array of ElementsMission
_begin Real
_end Real


Back To Top

ElementsProgress

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
_id String The unique ID of the progress instance
_profile ElementsProfile
_mission ElementsProgressMissionInfo The mission
_current_step ElementsStep The final repeating step (may be null if step(s) are specified)
_remaining Real The remaining actions
_reward_issuances Array of ElementsRewardIssuance List of all reward issuances that are issued but not expired, or redeemed but persistent.
_sequence Real The current number of completed steps. Note that this may exceed the total number of steps, i.e. the final step may be repeated infinitely.
_managed_by_schedule Real Indicates that this progress is managed by a Schedule. If true, the Progress will be deleted when no schedules have the progress active. This will be true if the Progress was created as part of a Schedule.
_schedules Array of ElementsSchedule A listing of the Schedules which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.
_schedule_events Array of ElementsScheduleEvent A listing of ScheduleEvents which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.


Back To Top

ElementsPaginationProgress


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsProgress


Back To Top

ElementsProgressRow

This struct is referenced by the following structs:


Member Type Description
_id String
_profile_id String
_profile_image_url String
_profile_display_name String
_step_display_name String
_step_description String
_remaining Real
_step_count Real


Back To Top

ElementsTabulationProgressRow


Member Type Description
_rows Array of ElementsProgressRow


Back To Top

ElementsPaginationRewardIssuance


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsRewardIssuance


Back To Top

ElementsRewardIssuanceRedemptionResult


Member Type Description
_reward_issuance_id String The id as originally provided in the request.
_reward_issuance ElementsRewardIssuance Represents a Reward that has been issued but has not yet been claimed by the user. The reward is assigned a unique ID to ensure that it may not have been applied more than once.
_inventory_item ElementsInventoryItem Should the redemption be successful, the Inventory Item that was updated. Otherwise, null.
_error_details String Should the redemption fail, the error details. Otherwise, null.


Back To Top

ElementsCreateScheduleEventRequest

This struct is referenced by the following functions:


Member Type Description
_mission_names_or_ids Array of String
_begin Real
_end Real


Back To Top

ElementsPaginationScheduleEvent


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsScheduleEvent


Back To Top

ElementsUpdateScheduleEventRequest

This struct is referenced by the following functions:


Member Type Description
_mission_names_or_ids Array of String
_begin Real
_end Real


Back To Top

ElementsCreateScheduleRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_display_name String
_description String


Back To Top

ElementsPaginationSchedule


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsSchedule


Back To Top

ElementsUpdateScheduleRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_display_name String
_description String


Back To Top

ElementsFCMRegistration

This struct is referenced by the following functions:


Member Type Description
_registration_token String The actual Firebase registration.
_id String The the unique id of the token stored in the database.
_profile ElementsProfile


Back To Top

ElementsCreateProfileRequest

This struct is referenced by the following functions:


Member Type Description
_user_id String The user id this profile belongs to.
_application_id String The application id this profile belongs to.
_image_url String A URL to the image of the profile. (ie the User's Avatar).
_display_name String A non-unique display name for this profile.
_metadata Struct A map of arbitrary metadata.


Back To Top

ElementsUpdateProfileRequest

This struct is referenced by the following functions:


Member Type Description
_image_url String A URL to the image of the profile. (ie the User's Avatar).
_display_name String A non-unique display name for this profile.
_metadata Struct A map of arbitrary metadata.


Back To Top

ElementsUpdateProfileImageRequest

This struct is referenced by the following functions:


Member Type Description
_mime_type String MimeType of image


Back To Top

ElementsSaveDataDocument

This struct is referenced by the following structs:


Member Type Description
_version String The revision of the save data document.
_contents String The contents of the save data.
_id String The database assigned unique ID of the document.
_slot Real The slot of the property.
_user ElementsUser The User associated with this Profile.
_profile ElementsProfile
_timestamp Real The timestamp of the last write to this document.


Back To Top

ElementsCreateSaveDataDocumentRequest

This struct is referenced by the following functions:


Member Type Description
_slot Real The slot of the property. Must be unique for user or profile.
_contents String The contents of the save data.
_user_id String The id of the user which owns the save data. If specified, the user will own this save data and the profileId must be null or be owned by the user specified.
_profile_id String The id of the profile which owns the save data. If specified, the profile will own this save data and the userId must be null or be owned by the user specified.


Back To Top

ElementsPaginationSaveDataDocument


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsSaveDataDocument


Back To Top

ElementsUpdateSaveDataDocumentRequest

This struct is referenced by the following functions:


Member Type Description
_contents String
_force Real
_version String


Back To Top

ElementsCreateMetadataSpecRequest

This struct is referenced by the following functions:


Member Type Description
_properties Array of ElementsMetadataSpecProperty The token template tabs to create.
_name String The name of the metadata spec.
_type String The type of the metadata spec.


Back To Top

ElementsEditorLayout

This struct is referenced by the following structs:


Member Type Description
_key String
_title String
_placeholder String


Back To Top

ElementsJsonSchema

This struct is referenced by the following structs:


Member Type Description
_get_id String See - https://json-schema.org/draft/2020-12/json-schema-core
_get_schema String See - https://json-schema.org/draft/2020-12/json-schema-core
_title String See - https://json-schema.org/draft/2020-12/json-schema-core
_description String See - https://json-schema.org/draft/2020-12/json-schema-core
_type String See - https://json-schema.org/draft/2020-12/json-schema-core
_properties Struct See - https://json-schema.org/draft/2020-12/json-schema-core
_required Array of String See - https://json-schema.org/draft/2020-12/json-schema-core


Back To Top

ElementsEditorSchema


Member Type Description
_data Struct The data itself.
_schema ElementsJsonSchema A Subset of the JSON-Schema - https://json-schema.org/draft/2020-12/json-schema-core
_layout Array of ElementsEditorLayout The editor layout.


Back To Top

ElementsJsonSchemaProperty


Member Type Description
_type String See - https://json-schema.org/draft/2020-12/json-schema-core
_title String See - https://json-schema.org/draft/2020-12/json-schema-core
_description String See - https://json-schema.org/draft/2020-12/json-schema-core
_required Array of String See - https://json-schema.org/draft/2020-12/json-schema-core


Back To Top

ElementsPaginationMetadataSpec


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsMetadataSpec


Back To Top

ElementsUpdateMetadataSpecRequest

This struct is referenced by the following functions:


Member Type Description
_name String The name of the metadata spec.
_type String The type of the metadata spec.
_properties Array of ElementsMetadataSpecProperty The updated list of properties.


Back To Top

ElementsMockSessionCreation


Member Type Description
_session_secret String The Session Secret to pass to subsequent requests through headers.
_session ElementsSession The Session object generated by the request.
_user_expires_at Real The assocaited mock user will automatically be deleted at supplied time.
_password String The randomly-assigned password for the mock user.


Back To Top

ElementsMockSessionRequest

This struct is referenced by the following functions:


Member Type Description
_lifetime_in_seconds Real The lifetime of the user in seconds. After this amount of time,
_application ElementsApplication


Back To Top

ElementsUsernamePasswordSessionRequest

This struct is referenced by the following functions:


Member Type Description
_user_id String The user ID.
_password String The password.
_profile_id String The profile ID to assign to the session.
_profile_selector String A query string to select the profile to use.


Back To Top

ElementsDatabaseHealthStatus

This struct is referenced by the following structs:


Member Type Description
_name String
_metadata String


Back To Top

ElementsDiscoveryHealthStatus

This struct is referenced by the following structs:


Member Type Description
_records Array of String
_known_hosts Array of String


Back To Top

ElementsInstanceHealthStatus

This struct is referenced by the following structs:


Member Type Description
_instance_id String
_node_ids Array of String


Back To Top

ElementsRoutingHealthStatus

This struct is referenced by the following structs:


Member Type Description
_instance_id String
_routing_table Array of String
_master_node_routing_table Array of String
_application_node_routing_table Array of String


Back To Top

ElementsInvokerHealthStatus

This struct is referenced by the following structs:


Member Type Description
_priorities Array of String
_connected_peers Array of String


Back To Top

ElementsHealthStatus


Member Type Description
_checks_failed Real
_checks_performed Real
_overall_health Real
_problems Array of String
_instance_status ElementsInstanceHealthStatus
_database_status Array of ElementsDatabaseHealthStatus
_discovery_health_status ElementsDiscoveryHealthStatus
_routing_health_status ElementsRoutingHealthStatus
_invoker_health_status ElementsInvokerHealthStatus


Back To Top

ElementsVersion


Member Type Description
_version String
_revision String
_timestamp String


Back To Top

ElementsUserCreateResponse


Member Type Description
_id String
_name String
_email String
_first_name String
_last_name String
_level String
_active Real
_facebook_id String
_firebase_id String
_apple_sign_in_id String
_primary_phone_nb String
_profiles Array of ElementsProfile
_password String
_linked_accounts Array of String


Back To Top

ElementsCreateProfileSignupRequest

This struct is referenced by the following structs:


Member Type Description
_application_id String The application id this profile belongs to.
_display_name String A non-unique display name for this profile. If left null, the server will assign.
_image_url String A URL to the image of the profile. (ie the User's Avatar). If left null, the server will no assign any URL.


Back To Top

ElementsUserCreateRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_email String
_primary_phone_nb String
_first_name String
_last_name String
_password String The user's plaintext password, only to be provided in POST/PUT requests in the User Resource REST API interface. In the future, a dedicated REST API model may be constructed instead of using a direct User model.
_level String The user's level to assign. Depending on the usage, the server may ignore this field and assign its own description.
_profiles Array of ElementsCreateProfileSignupRequest A list of profiles to assign to this user during creation. The server will attempt to create a profile for each item in this list.


Back To Top

ElementsPaginationUser


Member Type Description
_offset Real
_total Real
_approximation Real
_objects Array of ElementsUser


Back To Top

ElementsUserUpdateRequest

This struct is referenced by the following functions:


Member Type Description
_name String
_email String
_level String
_primary_phone_nb String
_first_name String
_last_name String
_password String The user's plaintext password, only to be provided in POST/PUT requests in the User Resource REST API interface. In the future, a dedicated REST API model may be constructed instead of using a direct User model.


Back To Top

ElementsUserUpdatePasswordRequest

This struct is referenced by the following functions:


Member Type Description
_old_password String The user's current password.
_new_password String The user's updated password.
_profile_id String The user's profile id to assign the new session. Leave blank for no profile id.


Back To Top

ElementsErrorResponse


Member Type Description
_code String A machine readable code of the error.
_message String A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.