Class NSQuotePublishDocuments

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

Syntax

Constructors

NSQuotePublishDocuments()

Initializes a new instance of the NSQuotePublishDocuments class.

Introduced or updated in version: 7.5

Declaration

NSQuotePublishDocuments

Methods

GetErrorMessage()

Introduced or updated in version: 7.5

Declaration

String GetErrorMessage()

Returns

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

Examples

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

GetMailBody()

Introduced or updated in version: 7.5

Declaration

String 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.

Examples

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

GetMailSubject()

Introduced or updated in version: 7.5

Declaration

String 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.

Examples

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

GetQuoteAttachmentIds()

Introduced or updated in version: 7.5

Declaration

Integer[] GetQuoteAttachmentIds()

Returns

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

Examples

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

GetQuoteDocumentId()

Introduced or updated in version: 7.5

Declaration

Integer GetQuoteDocumentId()

Returns

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

Examples

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

GetQuotedProductsId()

Introduced or updated in version: 7.5

Declaration

Integer GetQuotedProductsId()

Returns

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

Examples

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

GetToEmail()

Introduced or updated in version: 7.5

Declaration

String GetToEmail()

Returns

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

Examples

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

GetToFullName()

Introduced or updated in version: 7.5

Declaration

String GetToFullName()

Returns

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

Examples

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

SetErrorMessage(String)

Introduced or updated in version: 7.5

Declaration

Void SetErrorMessage(String errorMessage)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetMailBody(String)

Introduced or updated in version: 7.5

Declaration

Void SetMailBody(String 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

Examples

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

SetMailSubject(String)

Introduced or updated in version: 7.5

Declaration

Void SetMailSubject(String 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

Examples

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

SetQuoteAttachmentIds(Integer[])

Introduced or updated in version: 7.5

Declaration

Void SetQuoteAttachmentIds(Integer[] quoteAttachmentIds)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetQuoteDocumentId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetQuoteDocumentId(Integer 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

Examples

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

SetQuotedProductsId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetQuotedProductsId(Integer quotedProductsId)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetToEmail(String)

Introduced or updated in version: 7.5

Declaration

Void SetToEmail(String toEmail)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetToFullName(String)

Introduced or updated in version: 7.5

Declaration

Void SetToFullName(String toFullName)

Parameters

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

Returns

Type	Description
Void

Examples

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