Table of Contents

Class MimeReferenceContent

Namespace
Geotab.Checkmate.ObjectModel
Assembly
Geotab.Checkmate.ObjectModel.dll

A reference to data to be used as the contents of a TextMessage

Referenced will be converted into MimeContent prior to sending

public class MimeReferenceContent : MimeContentBase
Inheritance
MimeReferenceContent
Inherited Members

Constructors

MimeReferenceContent()

Initializes a new instance of the MimeReferenceContent class.

public MimeReferenceContent()

Properties

ByteCount

Gets or sets the byte count of the referenced data

public int? ByteCount { get; set; }

Property Value

int?

int

ComponentType

Gets the component type of the message.

public override int ComponentType { get; }

Property Value

int

Channel number int.

CustomFooter

Gets or sets custom footer data to append to referenced data

public byte[]? CustomFooter { get; set; }

Property Value

byte[]

byte buffer

CustomHeader

Gets or sets custom header data that will be prepended to referenced content

public byte[]? CustomHeader { get; set; }

Property Value

byte[]

byte buffer

Data

Gets or sets the raw bytes to either send to an Add-On or that were received from an Add-On. Maximum 2GB can be sent in a single message.

public override byte[]? Data { get; set; }

Property Value

byte[]

Array of byte

IsNotFound

Gets or sets a value indicating whether the referenced content could be found Will throw an ArgumentException if set to false when it is currently true.

public bool IsNotFound { get; set; }

Property Value

bool

bool

MimeType

Gets or sets the media type of content contained in the data field. Free string, Maximum 255 characters.

public override string? MimeType { get; set; }

Property Value

string

string

PayloadLength

Gets the length of the binary message that will be generated by referenced data not including the MimeType header

public int PayloadLength { get; }

Property Value

int

int

ReferenceFileName

Gets or sets the name of the file containing the referenced data Typically, the name with be a uuid followed by the file externsion

public string? ReferenceFileName { get; set; }

Property Value

string

string

StartByte

Gets or sets the start byte of the reference data

public long? StartByte { get; set; }

Property Value

long?

long

TotalLength

Gets the total length of the binary message that will be generated by referenced data

public int TotalLength { get; }

Property Value

int

int

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int