Attachment class: Difference between revisions
From Catglobe Wiki
More actions
Nguyenduyan (talk | contribs) No edit summary |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
|Name=<nowiki>Attachment</nowiki> | |Name=<nowiki>Attachment</nowiki> | ||
|Description=<nowiki>Represents an attachment object.</nowiki> | |Description=<nowiki>Represents an attachment object.</nowiki> | ||
|Constructors= | |InheritsFrom=object|Constructors= | ||
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>ResourceId of existing attachment.</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>ResourceId of existing attachment.</nowiki>}} | ||
| Line 13: | Line 13: | ||
|Description=<nowiki>Create new attachment.</nowiki>}} | |Description=<nowiki>Create new attachment.</nowiki>}} | ||
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ReadContentAsString</nowiki>|Description=<nowiki>Load the content of the file as a string.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ReadContentAsString</nowiki>|Description=<nowiki>Load the content of the file as a string.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveFromDownload</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveFromDownload</nowiki>|Parameters= | ||
| Line 26: | Line 23: | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>Content of the file</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>filename</nowiki>|Description=<nowiki>Name of the file</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>Content of the file</nowiki>}} | ||
|Description=<nowiki>Save from a string.</nowiki>}} | |Description=<nowiki>Save from a string.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedByUserResourceId</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedByUserResourceId</nowiki>}} | ||
| Line 38: | Line 35: | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PublicUrl</nowiki>|HasGetter=1|Description=<nowiki>Url to use to download for anyone</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>PublicUrl</nowiki>|HasGetter=1|Description=<nowiki>Url to use to download for anyone</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the Attachment</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the Attachment</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|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | ||
|StaticMethods= | |||
{{CGscriptMethods_Template|ReturnType=Array of Attachment|Name=<nowiki>Attachment_getChildAttachments</nowiki>|Parameters= | |||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource.</nowiki>}} | |||
|Description=<nowiki>Get all of the attachments associated with the resource.</nowiki>}} | |||
}} | }} | ||
(see more at: [[Attachment_getChildAttachments]]) | |||
Latest revision as of 06:35, 2 July 2020
Attachment
Represents an attachment object.
Parent class
Inherits from object
Constructors
- (int resourceId "ResourceId of existing attachment.") - Fetch existing attachment.
- (int parentResourceId "ParentResourceId of existing attachment.", string name "Name of existing attachment.") - Fetch existing attachment.
- (string name "Resource name. If set to empty, the name is taken from the downloaded or copied file.", int parentResourceId "Parent resource.") - Create new attachment.
Methods
- string ReadContentAsString() - Load the content of the file as a string.
- 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.
- Empty SaveFromString(string filename "Name of the file", string content "Content of the file") - Save from a string.
- (From object) string ToString() - The string representation of the object.
Properties
- int CreatedByUserResourceId { get; } - Get CreatedByUserResourceId
- DateTime CreatedDate { get; } - Get CreatedDate
- int FileSize { get; } - The size of the file on disk
- string InlineImageSrc { get; } - The uri to use in mails when inlining images
- 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 download for anyone
- int ResourceId { get; } - The Id of the Attachment
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Static Methods
- Array of Attachment Attachment_getChildAttachments(int parentResourceId "Parent resource.") - Get all of the attachments associated with the resource.
(see more at: Attachment_getChildAttachments)