Class QuotaSystem
Defined in File QuotaSystem.h
Inheritance Relationships
Base Type
public csp::systems::SystemBase(Class SystemBase)
Class Documentation
-
class QuotaSystem : public csp::systems::SystemBase
Public facing system that allows interfacing with Magnopus Connect Services’ Quota Server.
Offers methods for receiving Quota Queries. All functions in the quota system require the user to be logged in.
Public Functions
-
void GetTotalSpacesOwnedByUser(FeatureLimitCallback Callback)
Get the total number of Spaces owned by the current user and their tier space limit.
- Parameters
Callback – FeatureProgressCallback : callback when asynchronous task finishes
-
void GetConcurrentUsersInSpace(const csp::common::String &SpaceId, FeatureLimitCallback Callback)
Gets total number of user inside of a space and its tier user limit.
- Parameters
SpaceId – csp::common::String : Id of the Space
Callback – FeatureLimitCallback : callback when asynchronous task finishes
-
void GetTotalSpaceSizeInKilobytes(const csp::common::String &SpaceId, FeatureLimitCallback Callback)
Get total size of all assets within a space and their tier space size limit.
- Parameters
SpaceId – csp::common::String : Id of the Space
Callback – FeatureLimitCallback : callback when asynchronous task finishes
-
void GetTierFeatureProgressForUser(const csp::common::Array<TierFeatures> &FeatureNames, FeaturesLimitCallback Callback)
Get Array of feature progresses for a user and their tier feature limits.
- Parameters
FeatureNames – csp::common::Array<TierFeatures> : Array of feature names that will be retrieved
Callback – FeaturesLimitCallback : callback when asynchronous task finishes
-
void GetTierFeatureProgressForSpace(const csp::common::String &SpaceId, const csp::common::Array<TierFeatures> &FeatureNames, FeaturesLimitCallback Callback)
Get Array of feature progress for a user Space and its tier feature limits.
- Parameters
SpaceId – csp::common::String : Id of the Space
FeatureNames – csp::common::Array<TierFeatures> : Array of feature names that will be retrieved
Callback – FeaturesLimitCallback : callback when asynchronous task finishes
-
void SetUserTier(TierNames Tier, const csp::common::String &UserId, UserTierCallback Callback)
Set the tier of the user.
Tiers effect things such as limits of users inside spaces, among other quota restrictions
- Parameters
Tier – TierNames : Tier to set.
UserId – csp::common::String : Id of the user to set the tier for.
Callback – UserTierCallback : callback when asynchronous task finishes.
- Pre
This method should only be called when logged in as an administrator tier account. If called when not an administrator, you will receive a 403 error (Forbidden)
-
void GetCurrentUserTier(UserTierCallback Callback)
Get current users tier information.
- Parameters
Callback – UserTierCallback : callback when asynchronous task finishes
-
void GetTierFeatureQuota(TierNames TierName, TierFeatures FeatureName, FeatureQuotaCallback Callback)
Get current feature quota information.
- Parameters
TierName – TierNames : Name of the tier
FeatureName – TierFeatures : Name of the feature
Callback – FeatureQuotaCallback : callback when asynchronous task finishes
-
void GetTierFeaturesQuota(TierNames TierName, FeaturesQuotaCallback Callback)
Get current array of current feature quota information inside a tier.
- Parameters
TierName – TierNames : Name of the tier
Callback – FeaturesQuotaCallback : callback when asynchronous task finishes
-
void GetTotalSpacesOwnedByUser(FeatureLimitCallback Callback)