Class AttachmentEntity

The Attachment carrier represent meta data for a Service attachment

Carrier object for AttachmentEntity. Services for the AttachmentEntity Carrier is available from the ITicketAgent.
Inheritance
Object
AttachmentEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class AttachmentEntity : Carrier
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }

Constructors

AttachmentEntity()

Default constructor

Declaration
public AttachmentEntity()
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

Properties

AttachmentId

The primary key (auto-incremented)

Declaration
public virtual int AttachmentId { get; set; }
Property Value
Type Description
Int32
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

AttSize

The size (in bytes) for the attachment.

Declaration
public virtual int AttSize { get; set; }
Property Value
Type Description
Int32
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

AuthKey

The key used for authenticating access to this attachment.

Declaration
public virtual string AuthKey { get; set; }
Property Value
Type Description
String
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

ContentId

The content_id of this attachment, used for inline images

Declaration
public virtual string ContentId { get; set; }
Property Value
Type Description
String
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

ContentType

The content type for the attachment (e.g. 'applaction/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document').

Declaration
public virtual string ContentType { get; set; }
Property Value
Type Description
String
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

InlineImage

True if this attachment is inlined in the html_body.

Declaration
public virtual bool InlineImage { get; set; }
Property Value
Type Description
Boolean
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

IsSafeFileExtension

Is file considered to be safe (based on extension and settings)

Declaration
public virtual bool IsSafeFileExtension { get; set; }
Property Value
Type Description
Boolean
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

Name

The filename for the attachment.

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get AttachmentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new TicketAgent();
    var attachmentEntity = agent.GetAttachmentEntity( 123 );
 }
See Also

See Also