Class NSQuotePublishDocuments

Prepare the documents required to publish a quote - Email, main document as pdf, quoted products as pdf, attachments.

Constructors

NSQuotePublishDocuments()

Initializes a new instance of the NSQuotePublishDocuments class.

Declaration

NSQuotePublishDocuments

Methods

GetErrorMessage()

Declaration

String GetErrorMessage()

Examples

NSQuotePublishDocuments thing;
String errorMessage = thing.GetErrorMessage();

Returns

Type Description
String If something went wrong, show this message and do not continue.

GetMailBody()

Declaration

String GetMailBody()

Examples

NSQuotePublishDocuments thing;
String mailBody = thing.GetMailBody();

Returns

Type Description
String The string that is the content of the mail body; this is the result of merging the mail body template with the current template variable values.

GetMailSubject()

Declaration

String GetMailSubject()

Examples

NSQuotePublishDocuments thing;
String mailSubject = thing.GetMailSubject();

Returns

Type Description
String The string that is the mail subject; done by merging the text resource SR_QUOTE_PUBLISH_MAILHEADING with the current template variable values.

GetQuoteAttachmentIds()

Declaration

Integer[] GetQuoteAttachmentIds()

Examples

NSQuotePublishDocuments thing;
Integer[] quoteAttachmentIds = thing.GetQuoteAttachmentIds();

Returns

Type Description
Integer[] Array of IDs of any attachments (standard + custom for this version).

GetQuoteDocumentId()

Declaration

Integer GetQuoteDocumentId()

Examples

NSQuotePublishDocuments thing;
Integer quoteDocumentId = thing.GetQuoteDocumentId();

Returns

Type Description
Integer Quote document, as PDF; may be zero if there is no document specified for the version.

GetQuotedProductsId()

Declaration

Integer GetQuotedProductsId()

Examples

NSQuotePublishDocuments thing;
Integer quotedProductsId = thing.GetQuotedProductsId();

Returns

Type Description
Integer Quoted products (quote lines or confirmation lines) document, as PDf.

GetToEmail()

Declaration

String GetToEmail()

Examples

NSQuotePublishDocuments thing;
String toEmail = thing.GetToEmail();

Returns

Type Description
String The email address of the recipient, taken from the sale's person.

GetToFullName()

Declaration

String GetToFullName()

Examples

NSQuotePublishDocuments thing;
String toFullName = thing.GetToFullName();

Returns

Type Description
String The full name of the recipient, taken from the sale's person.

SetErrorMessage(String)

Declaration

Void SetErrorMessage(String errorMessage)

Examples

NSQuotePublishDocuments thing;
String errorMessage;
thing.SetErrorMessage(errorMessage);

Parameters

Type Name Description
String errorMessage If something went wrong, show this message and do not continue.

Returns

Type Description
Void

SetMailBody(String)

Declaration

Void SetMailBody(String mailBody)

Examples

NSQuotePublishDocuments thing;
String mailBody;
thing.SetMailBody(mailBody);

Parameters

Type Name Description
String mailBody The string that is the content of the mail body; this is the result of merging the mail body template with the current template variable values.

Returns

Type Description
Void

SetMailSubject(String)

Declaration

Void SetMailSubject(String mailSubject)

Examples

NSQuotePublishDocuments thing;
String mailSubject;
thing.SetMailSubject(mailSubject);

Parameters

Type Name Description
String mailSubject The string that is the mail subject; done by merging the text resource SR_QUOTE_PUBLISH_MAILHEADING with the current template variable values.

Returns

Type Description
Void

SetQuoteAttachmentIds(Integer[])

Declaration

Void SetQuoteAttachmentIds(Integer[] quoteAttachmentIds)

Examples

NSQuotePublishDocuments thing;
Integer[] quoteAttachmentIds;
thing.SetQuoteAttachmentIds(quoteAttachmentIds);

Parameters

Type Name Description
Integer[] quoteAttachmentIds Array of IDs of any attachments (standard + custom for this version).

Returns

Type Description
Void

SetQuoteDocumentId(Integer)

Declaration

Void SetQuoteDocumentId(Integer quoteDocumentId)

Examples

NSQuotePublishDocuments thing;
Integer quoteDocumentId;
thing.SetQuoteDocumentId(quoteDocumentId);

Parameters

Type Name Description
Integer quoteDocumentId Quote document, as PDF; may be zero if there is no document specified for the version.

Returns

Type Description
Void

SetQuotedProductsId(Integer)

Declaration

Void SetQuotedProductsId(Integer quotedProductsId)

Examples

NSQuotePublishDocuments thing;
Integer quotedProductsId;
thing.SetQuotedProductsId(quotedProductsId);

Parameters

Type Name Description
Integer quotedProductsId Quoted products (quote lines or confirmation lines) document, as PDf.

Returns

Type Description
Void

SetToEmail(String)

Declaration

Void SetToEmail(String toEmail)

Examples

NSQuotePublishDocuments thing;
String toEmail;
thing.SetToEmail(toEmail);

Parameters

Type Name Description
String toEmail The email address of the recipient, taken from the sale's person.

Returns

Type Description
Void

SetToFullName(String)

Declaration

Void SetToFullName(String toFullName)

Examples

NSQuotePublishDocuments thing;
String toFullName;
thing.SetToFullName(toFullName);

Parameters

Type Name Description
String toFullName The full name of the recipient, taken from the sale's person.

Returns

Type Description
Void