Class BlobEntity

Carrier object for BlobEntity. Services for the BlobEntity Carrier is available from the IBLOBAgent.

Inheritance
Object
BlobEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class BlobEntity : Carrier
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }

Constructors

BlobEntity()

Default constructor

Declaration
public BlobEntity()
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

Properties

BlobId

Primary key

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

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

BlobSize

The length, in bytes, of the binary data AS STORED after any encryption and/or zipping. Important to get right, since some databases will not tell us just based on the blob itself!

Declaration
public virtual uint BlobSize { get; set; }
Property Value
Type Description
UInt32
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

ConceptualType

The type, for instance PHOTO, PERSONPHOTO, or whatever, that is descriptive of what kind of image or data this is

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

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

CreatedBy

The person that first created the document. The property is read-only.

Declaration
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

CreatedDate

Registered when in UTC.

Declaration
public virtual DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

Description

A description that is entered by the user, and visible to the user

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

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

ExtraInfo

Extra information, spare field, can be used for anything that makes sense. Should not refer to any particular context, that is something for the BinaryObjectLInk

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

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

IsEncrypted

Has the data been encrypted.

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

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

IsZipped

Has the data been zipped.

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

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

MimeType

Mime type, describing the technical type (image/jpeg) of the data

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

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

OriginalSize

Original size of the binary data, before encryption and/or zipping. This is what the ultimate client will get

Declaration
public virtual uint OriginalSize { get; set; }
Property Value
Type Description
UInt32
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

UpdatedBy

The person that last updated the appointment.

Declaration
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

UpdatedDate

Last updated when in UTC.

Declaration
public virtual DateTime UpdatedDate { get; set; }
Property Value
Type Description
DateTime
Examples

Get BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 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 BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 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 BlobEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new BLOBAgent();
    var blobEntity = agent.GetBlobEntity( 123 );
 }
See Also

See Also