Difference between revisions of "Image class"

From Catglobe Wiki
Jump to: navigation, search
Line 10: Line 10:
 
|Description=<nowiki>Create new image.</nowiki>}}
 
|Description=<nowiki>Create new image.</nowiki>}}
 
|Methods=
 
|Methods=
{{CGscriptMethods_Template|ReturnType=Array of objects|Name=<nowiki>GetChildImages</nowiki>|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource.</nowiki>}}
 
|Description=<nowiki>Get all of the images associated with the resource.</nowiki>}}
 
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveFromDownload</nowiki>|Parameters=
 
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveFromDownload</nowiki>|Parameters=
 
{{CGscriptParameters_Template|Type=WebResponse|Name=<nowiki>response</nowiki>|Description=<nowiki>Response from HttpRequest</nowiki>}}
 
{{CGscriptParameters_Template|Type=WebResponse|Name=<nowiki>response</nowiki>|Description=<nowiki>Response from HttpRequest</nowiki>}}
Line 30: Line 27:
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the image</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>}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 +
|StaticMethods=
 +
{{CGscriptMethods_Template|ReturnType=Array of objects|Name=<nowiki>Image_getChildImages</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource.</nowiki>}}
 +
|Description=<nowiki>Get all of the images associated with the resource.</nowiki>}}
 
}}
 
}}

Revision as of 10:11, 11 July 2018

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

  • 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.

Static Methods

  • Array of objects Image_getChildImages(int parentResourceId "Parent resource.") - Get all of the images associated with the resource.