This comprehensive guide covers all theme objects, variables, and data structures available in Aikeedo themes. Each object provides specific functionality and data access for building dynamic theme components.
The user object is a fundamental component in Aikeedo themes, providing access to essential user information when a user is logged into their account. This object is globally accessible, allowing you to easily incorporate user-specific data and functionality into your theme.The user object is available globally when a user is logged in. If no user is logged in, the object will be undefined. Always check for the existence of the user object before attempting to access its properties.
It’s a good practice to use conditional checks when working with the user object to ensure your theme functions correctly for both logged-in and guest users.
Unix timestamp of the last update to the user account. While this field always exists, its value may be null if the user account has never been updated.
An array of workspace objects that the user is a member of, excluding workspaces owned by the user. Each object in this array represents a workspace where the user has membership but not ownership. See Workspace Object for more details on the properties of these objects.
The affiliate object provides access to essential affiliate information for users participating in the affiliate program. This object is part of the user object and contains details about the user’s affiliate status, earnings, and payout preferences.The affiliate object is always available as a property of the user object when a user is logged in. Affiliate accounts are automatically generated for each user, so you can safely access user.affiliate properties without additional checks for its existence.
The country object provides access to country information for users. This object contains details about the user’s country including name, codes, and flag information.The country object is available as a property of the user object. It may be null if the user’s country is not set.
The currency object provides access to currency information used throughout the system. This object is used to represent various currencies and their properties.The currency object is globally available and represents the global currency set in the billing settings. It can be accessed in other contexts where currency information is needed, such as in affiliate.currency or subscription.currency.
The number of digits typically used for fractional amounts of this currency (e.g., 2 for currenzcies like USD or EUR, which use cents, or 0 for currencies like JPY that don’t use fractional units).
The environment variable is used to determine the current execution environment in Aikeedo themes. This is important for making environment-specific decisions in your theme logic.The environment variable is available globally throughout the theme.
The locale object provides access to language and region information used throughout the system. This object is used to represent various locales and their properties.The locale object is available in various contexts throughout the Aikeedo system where language and region information is relevant. It can be accessed in theme templates and components to display localized content, format dates and numbers, or adapt the user interface to specific cultural preferences.
A unique identifier for the locale, typically following the format of language code and country/region code (e.g., “en-US” for English in the United States).
The locales array provides access to all available language and region configurations in the system. This array contains multiple Locale objects, each representing a specific language-region combination.The locales array is globally available throughout the Aikeedo system. It can be accessed in theme templates, components, and other contexts where information about all supported languages is needed. This array is particularly useful for implementing language selection features or displaying available language options to users.
The Plan object represents a subscription plan in Aikeedo themes, providing access to essential plan information. This object is part of the plans array, which is globally accessible, allowing you to easily incorporate plan-specific data and functionality into your theme.The Plan objects are available globally as part of the plans array. You can iterate through this array to access individual plan objects and their properties.
It’s a good practice to check if the plans array exists and has elements before attempting to access individual plan objects.
The plan_snapshot object represents a snapshot of a subscription plan at the time of subscription creation. This object is used in subscriptions to maintain the plan details even if the original plan is modified.The plan_snapshot object is available as a property of the subscription object.
The plan-config object contains configuration settings for different AI models, tools, and features available in a specific plan. It defines which capabilities are enabled and which models are accessible.The plan-config object is available as a property of the plan object. It can be accessed within theme templates when working with plan-related data.
The subscription object provides access to subscription information for a workspace or user. This object contains details about the subscription status, usage, and related information.The subscription object is available within the workspace or user.workspace objects.
The user object is a fundamental component in Aikeedo themes, providing access to essential user information when a user is logged into their account. This object is globally accessible, allowing you to easily incorporate user-specific data and functionality into your theme.The user object is available globally when a user is logged in. If no user is logged in, the object will be undefined. Always check for the existence of the user object before attempting to access its properties.
It’s a good practice to use conditional checks when working with the user object to ensure your theme functions correctly for both logged-in and guest users.
Unix timestamp of the last update to the user account. While this field always exists, its value may be null if the user account has never been updated.
An array of workspace objects that the user is a member of, excluding workspaces owned by the user. Each object in this array represents a workspace where the user has membership but not ownership. See Workspace Object for more details on the properties of these objects.
The version variable provides access to the currently installed version of the Aikeedo app. This can be useful for version-specific logic or displaying the app version in your theme.The version variable is available globally throughout the theme.
The view_namespace variable indicates which namespace the current view belongs to.The view_namespace variable is available globally throughout the theme.
The option variable provides access to all option settings configured in the admin panel.The option variable is available globally throughout the theme.
An object containing all option settings from the admin panel. This includes site settings, billing options, color schemes, and other customizable options.
The workspace object is a fundamental component in Aikeedo themes, representing a user’s working environment and associated settings. This object contains crucial information about the workspace, including subscription details, credit usage, and various configuration options.The workspace object is available globally when a user is logged into the app. Additionally, it is always accessible as a property of the user object. Each user has at least one workspace, so you can safely access workspace properties or user.workspace properties without additional checks for their existence.
The workspace’s address information. This may be null if not set. See Address Object for more details on the properties of this object when it’s not null.
The workspace_invitation object represents an invitation to join a workspace in Aikeedo themes. This object contains essential information about the invitation, including its unique identifier, the invited email address, and timestamps.The workspace_invitation object is available in contexts related to workspace management, such as when listing pending invitations or processing invitation responses.
Always check for the existence of the workspace_invitation object before attempting to access its properties to ensure your theme functions correctly in all invitation-related scenarios.
Unix timestamp of the last update to the workspace invitation. This may be the same as created_at if the invitation hasn’t been modified since creation.
