Show / Hide Table of Contents

Class NSAttachmentEntity

Syntax

Constructors

NSAttachmentEntity()

Initializes a new instance of the NSAttachmentEntity class.

Declaration
NSAttachmentEntity

Methods

GetAttachmentId()

Declaration
Integer GetAttachmentId()
Returns
Type Description
Integer

The primary key (auto-incremented).

Examples
NSAttachmentEntity thing;
Integer attachmentId = thing.GetAttachmentId();

GetAttSize()

Declaration
Integer GetAttSize()
Returns
Type Description
Integer

The size (in bytes) for the attachment.

Examples
NSAttachmentEntity thing;
Integer attSize = thing.GetAttSize();

GetContentId()

Declaration
String GetContentId()
Returns
Type Description
String

The content_id of this attachment, used for inline images.

Examples
NSAttachmentEntity thing;
String contentId = thing.GetContentId();

GetContentType()

Declaration
String GetContentType()
Returns
Type Description
String

The content type for the attachment.

Remarks

Types can for example be 'application/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'

Examples
NSAttachmentEntity thing;
String contentType = thing.GetContentType();

GetInlineImage()

Declaration
Bool GetInlineImage()
Returns
Type Description
Bool

True if this attachment is inlined in the html_body.

Examples
NSAttachmentEntity thing;
Bool inlineImage = thing.GetInlineImage();

GetName()

Declaration
String GetName()
Returns
Type Description
String

The filename for the attachment.

Examples
NSAttachmentEntity thing;
String name = thing.GetName();

SetAttachmentId(Integer)

Declaration
Void SetAttachmentId(Integer attachmentId)
Parameters
Type Name Description
Integer attachmentId

The primary key (auto-incremented).

Returns
Type Description
Void
Examples
NSAttachmentEntity thing;
Integer attachmentId;
thing.SetAttachmentId(attachmentId);

SetAttSize(Integer)

Declaration
Void SetAttSize(Integer attSize)
Parameters
Type Name Description
Integer attSize

The size (in bytes) for the attachment.

Returns
Type Description
Void
Examples
NSAttachmentEntity thing;
Integer attSize;
thing.SetAttSize(attSize);

SetContentId(String)

Declaration
Void SetContentId(String contentId)
Parameters
Type Name Description
String contentId

The content_id of this attachment, used for inline images.

Returns
Type Description
Void
Examples
NSAttachmentEntity thing;
String contentId;
thing.SetContentId(contentId);

SetContentType(String)

Declaration
Void SetContentType(String contentType)
Parameters
Type Name Description
String contentType

The content type for the attachment.

Returns
Type Description
Void
Remarks

Types can for example be 'application/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'.

Examples
NSAttachmentEntity thing;
String contentType;
thing.SetContentType(contentType);

SetInlineImage(Bool)

Declaration
Void SetInlineImage(Bool inlineImage)
Parameters
Type Name Description
Bool inlineImage

True if this attachment is inlined in the html_body.

Returns
Type Description
Void
Examples
NSAttachmentEntity thing;
Bool inlineImage;
thing.SetInlineImage(inlineImage);

SetName(String)

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name

The filename for the attachment.

Returns
Type Description
Void
Examples
NSAttachmentEntity thing;
String name;
thing.SetName(name);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top