Image class: Difference between revisions
From Catglobe Wiki
More actions
Nguyenduyan (talk | contribs) Created page with "{{CGscriptClass_Template |Name=Image |Description=Represents an image object. |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=int..." |
Nguyenduyan (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name=Image | |Name=<nowiki>Image</nowiki> | ||
|Description=Represents an image object. | |Description=<nowiki>Represents an image object.</nowiki> | ||
|Constructors= | |Constructors= | ||
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=resourceId|Description=ResourceId of existing image.}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>ResourceId of existing image.</nowiki>}} | ||
|Description=Fetch existing image.}} | |Description=<nowiki>Fetch existing image.</nowiki>}} | ||
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=name|Description=Resource name. If set to empty, the name is taken from the downloaded or copied file.|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=parentResourceId|Description=Parent resource.}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Resource name. If set to empty, the name is taken from the downloaded or copied file.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource.</nowiki>}} | ||
|Description=Create new image.}} | |Description=<nowiki>Create new image.</nowiki>}} | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=Array of objects|Name=GetChildImages|Parameters= | {{CGscriptMethods_Template|ReturnType=Array of objects|Name=<nowiki>GetChildImages</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=parentResourceId|Description=Parent resource.}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource.</nowiki>}} | ||
|Description=Get all of the images associated with the resource.}} | |Description=<nowiki>Get all of the images associated with the resource.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=SaveFromDownload|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveFromDownload</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=WebResponse|Name=response|Description=Response from HttpRequest}} | {{CGscriptParameters_Template|Type=WebResponse|Name=<nowiki>response</nowiki>|Description=<nowiki>Response from HttpRequest</nowiki>}} | ||
|Description=Download from an HttpRequest's response.}} | |Description=<nowiki>Download from an HttpRequest's response.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=SaveFromFileCopy|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveFromFileCopy</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=filename|Description=Name of the file|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isTemp|Description=Is the file temporary}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTemp</nowiki>|Description=<nowiki>Is the file temporary</nowiki>}} | ||
|Description=Copy from an already stored file using Catglobe.File.}} | |Description=<nowiki>Copy from an already stored file using Catglobe.File.</nowiki>}} | ||
{{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=Name|HasGetter=1|HasSetter=1|Description=Resource name. If set to empty, the name is taken from the downloaded or copied file.}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedByUserResourceId</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | {{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedDate</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=PublicUrl|HasGetter=1|Description=Url to use to view image for anyone}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ModifiedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get ModifiedByUserResourceId</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=ResourceId|HasGetter=1|Description=The Id of the image}} | {{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ModifiedDate</nowiki>|HasGetter=1|Description=<nowiki>Get ModifiedDate</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Resource name. If set to empty, the name is taken from the downloaded or copied file.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | |||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PublicUrl</nowiki>|HasGetter=1|Description=<nowiki>Url to use to view image for anyone</nowiki>}} | |||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the image</nowiki>}} | |||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | |||
}} | }} | ||
Revision as of 06:37, 2 November 2017
Image
Represents an image object.
Constructors
- (int resourceId "ResourceId of existing image.") - Fetch existing image.
- (string name "Resource name. If set to empty, the name is taken from the downloaded or copied file.", int parentResourceId "Parent resource.") - Create new image.
Methods
- Array of objects GetChildImages(int parentResourceId "Parent resource.") - Get all of the images associated with the resource.
- Empty SaveFromDownload(WebResponse response "Response from HttpRequest") - Download from an HttpRequest's response.
- Empty SaveFromFileCopy(string filename "Name of the file", bool isTemp "Is the file temporary") - Copy from an already stored file using Catglobe.File.
- string ToString() - The string representation of the object.
Properties
- int CreatedByUserResourceId { get; } - Get CreatedByUserResourceId
- DateTime CreatedDate { get; } - Get CreatedDate
- int ModifiedByUserResourceId { get; } - Get ModifiedByUserResourceId
- DateTime ModifiedDate { get; } - Get ModifiedDate
- string Name { get; set; } - Resource name. If set to empty, the name is taken from the downloaded or copied file.
- string ObjectTypeName { get; } - The name of the type of object.
- string PublicUrl { get; } - Url to use to view image for anyone
- int ResourceId { get; } - The Id of the image
- TypeInformation TypeInformation { get; } - Get information about this class.