Difference between revisions of "CatglobeCostPurchase class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=CatglobeCostPurchase |Description=Represents a purchase made |Methods= {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=Th...")
 
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=CatglobeCostPurchase
+
|Name=<nowiki>CatglobeCostPurchase</nowiki>
|Description=Represents a purchase made
+
|Description=<nowiki>Represents a purchase made</nowiki>
|Methods=
+
|InheritsFrom=object|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=BuyStatusAsString|HasGetter=1|Description=How was it bought}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>BuyStatusAsString</nowiki>|HasGetter=1|Description=<nowiki>How was it bought</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=ExpireDate|HasGetter=1|Description=When does the purchase expire. May be empty}}
+
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ExpireDate</nowiki>|HasGetter=1|Description=<nowiki>When does the purchase expire. May be empty</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=PurchaseDate|HasGetter=1|Description=When was the purchase}}
+
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>PurchaseDate</nowiki>|HasGetter=1|Description=<nowiki>When was the purchase</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=ResourceId|HasGetter=1|Description=For which resource was the purchase made}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>For which resource was the purchase made</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=Units|HasGetter=1|Description=How many units was purchased}}
+
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Units</nowiki>|HasGetter=1|Description=<nowiki>How many units was purchased</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=UsageStatusAsString|HasGetter=1|Description=What is current usage status}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>UsageStatusAsString</nowiki>|HasGetter=1|Description=<nowiki>What is current usage status</nowiki>}}
 
}}
 
}}
 +
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
 +
<source lang="javascript">
 +
number folderRId=15556593;
 +
array purInfo = Catglobe.Payment.GetPurchaseInformation(folderRId);
 +
CatglobeCostPurchase a = purInfo[0];
 +
print(a.BuyStatusAsString);
 +
print(a.ExpireDate);
 +
print(a.PurchaseDate);
 +
print(a.ResourceId);
 +
print(a.Units);
 +
print(a.UsageStatusAsString);
 +
</source>

Latest revision as of 08:40, 2 July 2020

CatglobeCostPurchase



Represents a purchase made

Parent class

Inherits from object

Methods

  • string ToString() - The string representation of the object.

Properties

  • string BuyStatusAsString { get; } - How was it bought
  • DateTime ExpireDate { get; } - When does the purchase expire. May be empty
  • string ObjectTypeName { get; } - The name of the type of object.
  • DateTime PurchaseDate { get; } - When was the purchase
  • int ResourceId { get; } - For which resource was the purchase made
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.
  • number Units { get; } - How many units was purchased
  • string UsageStatusAsString { get; } - What is current usage status


Examples

number folderRId=15556593;
array purInfo = Catglobe.Payment.GetPurchaseInformation(folderRId);
CatglobeCostPurchase a = purInfo[0];
print(a.BuyStatusAsString);
print(a.ExpireDate);
print(a.PurchaseDate);
print(a.ResourceId);
print(a.Units);
print(a.UsageStatusAsString);