LineItemGroups Class
Properties Methods Events Config Settings Errors
Generates a group aggregate for use in another class's Update request.
Syntax
inqb.Lineitemgroups
Remarks
There is not exposed a way to directly edit the contents of a line item group when submitting an Update request with a class from this package. You can change the Quantity, but you cannot change the line items contained inside the group line. The LineItemGroups class is used to parse a line item group aggregate. You may then make changes to the individual line items, and then call the GetGroupUpdateAggregate to return an xml aggregate containing your changes. This is then set to the Aggregate field of the line you wish to modify in your Update.
For instance, the following code changes the BillableStatus of all line items and line item groups in the Bill retrieved from QuickBooks.
Bill.Get("123456");
for (int i = 0; i < Bill1.LineItems.Count; i++) {
if (!Bill.LineItems[i].GroupName.Equals("")) { // this is a group line
LineItemGroups.GroupType = gtBill;
LineItemGroups.ParseAggregate(Bill.LineItems[0].Aggregate);
for (int j = 0; j < LineItemGroups.LineItems.Count) {
LineItemGroups.LineItems[j].BillableStatus = bsHasBeenBilled;
}
LineItemGroups.QBXMLVersion = Bill.QBXMLVersion; // so that the proper fields are included in the update aggregate.
Bill1.LineItems[i].Aggregate = LineItemGroups.GetGroupUpdateAggregate();
} else { // regular line item
Bill.LineItems[i].BillableStatus = bsHasBeenBilled;
}
}
Bill.Update();
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Description | A string description of the item group specified by GroupName or GroupId . |
GroupId | Reference to a group of line items. |
GroupName | Reference to a group of line items. |
GroupType | The type of line item group aggregate to create. |
LineId | Identification number of the transaction line group, used for Updates. |
LineItems | Collection of line items contained in this group. |
PrintItemsInGroup | Indicates whether line items will be shown on printed forms. |
QBXMLVersion | The version of QBXML used to generate the update aggregate. |
Quantity | The quantity of this line item group. |
TotalAmount | The total amount of this group of line items. |
UnitOfMeasure | Unit of measure describing the Quantity . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
GetGroupUpdateAggregate | Generates a group aggregate for use in another class's Update request. |
ParseAggregate | Parses the aggregate returned from another class's ItemAggregate property. |
Reset | Resets this class to its default state. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the class whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
Description Property (LineItemGroups Class)
A string description of the item group specified by GroupName or GroupId .
Syntax
public String getDescription();
Default Value
""
Remarks
This property will contain the description of the group as returned by QuickBooks.
This property is read-only and not available at design time.
GroupId Property (LineItemGroups Class)
Reference to a group of line items.
Syntax
public String getGroupId(); public void setGroupId(String groupId);
Default Value
""
Remarks
Line item groups represent sets of items that are grouped together.
A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.
When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular properties (total Amount, Quantity, and Description), but the line items returned are not normally accessible. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the Aggregate field of the original\ object to use in an Update transaction.
GroupName Property (LineItemGroups Class)
Reference to a group of line items.
Syntax
public String getGroupName(); public void setGroupName(String groupName);
Default Value
""
Remarks
Line item groups represent sets of items that are grouped together.
A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.
When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular properties (total Amount, Quantity, and Description), but the line items returned are not normally accessible. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the Aggregate field of the original\ object to use in an Update transaction.
GroupType Property (LineItemGroups Class)
The type of line item group aggregate to create.
Syntax
public int getGroupType(); public void setGroupType(int groupType); Enumerated values: public final static int gtStandardGroup = 0; public final static int gtCreditMemo = 1; public final static int gtEstimate = 2; public final static int gtInvoice = 3; public final static int gtPurchaseOrder = 4; public final static int gtSalesOrder = 5; public final static int gtSalesReceipt = 6;
Default Value
0
Remarks
This property will be automatically filled after a call to ParseAggregate. The following values are permitted:
gtStandardGroup (0) | Used for the Bill, CCCharge, CCCredit, Check, VendorCredit, and ItemReceipt classs. |
gtCreditMemo (1) | Corresponds to the CreditMemo class. |
gtEstimate (2) | Corresponds to the Estimate class. |
gtInvoice (3) | Corresponds to the Invoice class. |
gtPurchaseOrder (4) | Corresponds to the PurchaseOrder class. |
gtSalesOrder (5) | Corresponds to the SalesOrder class. |
gtSalesReceipt (6) | Corresponds to the SalesReceipt class. |
LineId Property (LineItemGroups Class)
Identification number of the transaction line group, used for Updates.
Syntax
public String getLineId(); public void setLineId(String lineId);
Default Value
""
Remarks
If you need to add a new transaction line group in a transaction Update request, you can do so by setting the LineId to -1.
LineItems Property (LineItemGroups Class)
Collection of line items contained in this group.
Syntax
public LineItemList getLineItems(); public void setLineItems(LineItemList lineItems);
Remarks
One or more line items describe the contents of a line item group. Line item groups represent sets of items that are grouped together. A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.
When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular fields (total Amount, Quantity, and Description), but the line items returned are not accessible with this object. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the Aggregate field to use in an Update transaction.
This property is not available at design time.
PrintItemsInGroup Property (LineItemGroups Class)
Indicates whether line items will be shown on printed forms.
Syntax
public boolean isPrintItemsInGroup();
Default Value
False
Remarks
If true, a list of this group's individual items their amounts will appear on printed forms.
This property is read-only and not available at design time.
QBXMLVersion Property (LineItemGroups Class)
The version of QBXML used to generate the update aggregate.
Syntax
public String getQBXMLVersion(); public void setQBXMLVersion(String QBXMLVersion);
Default Value
"3.0"
Remarks
This should match the QBXMLVersion of the class you're generating a group line update aggregate for.
This property is not available at design time.
Quantity Property (LineItemGroups Class)
The quantity of this line item group.
Syntax
public String getQuantity(); public void setQuantity(String quantity);
Default Value
""
Remarks
This field is a String type in order to allow setting fractional quantities. Setting this field with non-numeric data will cause an error. Correct usage of this field is shown below:
class.Quantity = "3"
Leave this field blank and no quantity will be sent to QuickBooks.
TotalAmount Property (LineItemGroups Class)
The total amount of this group of line items.
Syntax
public String getTotalAmount();
Default Value
""
Remarks
This field represents the total amount of all transaction lines in the group. This amount will be automatically computed by QuickBooks.
The amount should be formatted as a string in dollars.
This property is read-only and not available at design time.
UnitOfMeasure Property (LineItemGroups Class)
Unit of measure describing the Quantity .
Syntax
public String getUnitOfMeasure(); public void setUnitOfMeasure(String unitOfMeasure);
Default Value
""
Remarks
In a transaction line item, the name of the unit of measure selected from within the item's available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
This property is only available for QBXMLVersion 7.0 and higher.
Config Method (Lineitemgroups Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
GetGroupUpdateAggregate Method (Lineitemgroups Class)
Generates a group aggregate for use in another class's Update request.
Syntax
public String getGroupUpdateAggregate();
Remarks
There is not exposed a way to directly edit the contents of a line item group when submitting an Update request with a class from this package. You can change the Quantity, but you cannot change the line items contained inside the group line. The LineItemGroups class is used to parse a line item group aggregate. You may then make changes to the individual line items, and then call the GetGroupUpdateAggregate to return an xml aggregate containing your changes. This is then set to the Aggregate field of the line you wish to modify in your Update.
For instance, the following code changes the BillableStatus of all line items and line item groups in the Bill retrieved from QuickBooks.
Bill.Get("123456");
for (int i = 0; i < Bill1.LineItems.Count; i++) {
if (!Bill.LineItems[i].GroupName.Equals("")) { // this is a group line
LineItemGroups.GroupType = gtBill;
LineItemGroups.ParseAggregate(Bill.LineItems[0].Aggregate);
for (int j = 0; j < LineItemGroups.LineItems.Count) {
LineItemGroups.LineItems[j].BillableStatus = bsHasBeenBilled;
}
LineItemGroups.QBXMLVersion = Bill.QBXMLVersion; // so that the proper fields are included in the update aggregate.
Bill1.LineItems[i].Aggregate = LineItemGroups.GetGroupUpdateAggregate();
} else { // regular line item
Bill.LineItems[i].BillableStatus = bsHasBeenBilled;
}
}
Bill.Update();
ParseAggregate Method (Lineitemgroups Class)
Parses the aggregate returned from another class's ItemAggregate property.
Syntax
public void parseAggregate(String aggregate);
Remarks
This method takes the XML aggregate returned from any class's ItemAggregate property, and then fills all the properties of this class. For example:
Invoice.Add()
For (i = 0 to Invoice.ItemCount - 1)
LineItems.ParseAggregate(Invoice.ItemAggregate[0])
Debug.Print(LineItems.ItemName & VbTab & LineItems.Quantity & VbTab & LineItems.Amount)
Next
Reset Method (Lineitemgroups Class)
Resets this class to its default state.
Syntax
public void reset();
Remarks
This method clears all properties and returns the class to its default state.
Error Event (Lineitemgroups Class)
Information about errors during data delivery.
Syntax
public class DefaultLineitemgroupsEventListener implements LineitemgroupsEventListener { ... public void error(LineitemgroupsErrorEvent e) {} ... } public class LineitemgroupsErrorEvent { public int errorCode; public String description; }
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
LineItem Type
A single line item inside of an Item Group.
Remarks
This type of line item is used by the LineItemGroups class, and contains a superset of the fields from all other item types.
Fields
Aggregate String |
Contains an XML aggregate of the line item. If the line item has not been modified since receiving a response from QuickBooks, the exact LineRet aggregate that QuickBooks returned will be contained in this XML aggregate. However, if you have made changes to the this line item's fields the Aggregate field will re-generate the line item XML with the new data. If you set the other line item fields and then query the Aggregate, a LineRet aggregate will be generated from the currently set fields. You may set this field with raw xml. So long as you do not modify any other fields (forcing the line item to regenerate based on new changes), the xml will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this field. When setting this field manually, the class will send exactly what you have set. You must ensure your xml is appropriate for the action you are attempting. For instance, if you are Adding an Invoice, you must ensure the outer tags are "InvoiceLineAdd". If Modifying an Invoice, the outer tags must be "InvoiceLineMod". If you do not expressly set the Aggregate field with your own custom XML, all of this will be taken care of you automatically by the class. |
Amount String |
Line item field: the total amount of this item. This field represents the total amount of a transaction line. If Rate, Cost and/or Quantity are specified the Amount will be automatically computed by QuickBooks. Whether Rate or Cost is used will depend on the transaction type. Rate is available for CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, and SalesReceipt transactions while Cost is available for Bill, CCCharge, CCCredit, Check, ItemReceipt, and VendorCredit transactions. The amount should be formatted as a string in dollars. |
BillableStatus int |
Line item field: Billing status of this item. The billing status of this line item. If the billing status is empty (that is, if no billing status appears in QuickBooks), then no BillableStatus value will be returned. Values:
|
ClassId String |
Line item field: Reference to the class of the item. A reference to the class of this item. Id/Name Reference Properties This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined. Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined. Setting the value of this property will set the corresponding Name property to an empty string. |
ClassName String |
Line item field: Reference to the class of the item. Name/Id Reference Properties This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field. Setting the value of this property will set the corresponding Id property to an empty string. |
Cost String |
Line item field: Unit cost for item. The unit cost for this item. If Amount is specified, then Cost will be calculated automatically and should not be specified. The amount should be formatted as a string in dollars. |
CustomerId String |
Line item property: A reference to customer for whom the item was ordered. A reference to a Customer for whom this item was ordered. If this field is set, the expense will be set as billable to the Customer referenced. Id/Name Reference Properties This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined. Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined. Setting the value of this property will set the corresponding Name property to an empty string. |
CustomerName String |
Line item field: A reference to customer for whom the item was ordered. A reference to a Customer for whom this item was ordered. If this field is set, the expense will be set as billable to the Customer referenced. Name/Id Reference Properties This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field. Setting the value of this property will set the corresponding Id property to an empty string. |
Description String |
Line item field: Description of item. A string description of the Item specified by ItemName or ItemId. |
ItemId String |
Line item field: Reference to the kind of item. Line items represent goods or services bought in a QuickBooks transaction. Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual classs for details). Properties such as Quantity and Description are always present; some properties are found in only certain types of transactions. Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for Description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically. This class is used to create a single item. However, any InQB class may be set with an unlimited number of these items. For example:
Items may also be grouped into ItemGroups, using the LineItemGroups class. |
ItemName String |
Line item field: Reference to the kind of item. Line items represent goods or services bought in a QuickBooks transaction. Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual classs for details). Properties such as Quantity and Description are always present; some properties are found in only certain types of transactions. Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for Description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically. This class is used to create a single item. However, any InQB class may be set with an unlimited number of these items. For example:
Items may also be grouped into ItemGroups, using the LineItemGroups class. |
LineId String |
Identification number of the transaction line, used for Updates. If you need to add a new transaction line in a transaction Update request, you can do so by setting the LineId to -1. |
ManuallyClosed int |
Indicates if the line item has been manually closed. If ManuallyClosed is mcManuallyClosed, the purchase order line has been closed, even if this item has not been received or its sale canceled. If all the purchase order lines are marked as closed, the purchase order itself is marked as closed as well. You cannot change ManuallyClosed to mcNotManuallyClosed after the purchase order line has been fully received. If set to mcNotSet the field is not sent in the request. Only applicable to Update transactions. |
Other1 String |
Standard QuickBooks Custom Field available for transaction line items. The Other1 and Other2 custom fields are available for immediate use: you don't need to enable these in the transaction template to be able to access them via SDK. (However, those Other1 and Other2 fields and their values are viewable and printable in QuickBooks only if the transaction template has these enabled!). QBXMLVersion 6.0 or higher is required to use this field. |
Other2 String |
Standard QuickBooks Custom Field available for transaction line items. The Other1 and Other2 custom fields are available for immediate use: you don't need to enable these in the transaction template to be able to access them via SDK. (However, those Other1 and Other2 fields and their values are viewable and printable in QuickBooks only if the transaction template has these enabled!). QBXMLVersion 6.0 or higher is required to use this field. |
OverrideAccountId String |
An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting. |
OverrideAccountName String |
An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting. |
PriceLevelId String |
Line Item field: Used to specify custom pricing for specific customers. Id for the PriceLevel selected for this transaction. If PriceLevelId and/or PriceLevelName are specified, then Amount will be calculated automatically and should not be specified. Note that PriceLevelId and PriceLevelName, OR Rate OR RatePercent may be specified. PriceLevelId and PriceLevelName are ONLY available for QBXMLVersions 4.0 and above. You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.) The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders. Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the Rate, which was set using the price level. |
PriceLevelName String |
Line Item field: Specify custom pricing for specific customers. Id for the PriceLevel selected for this transaction. If PriceLevelId and/or PriceLevelName are specified, then Amount will be calculated automatically and should not be specified. Note that PriceLevelId and PriceLevelName, OR Rate OR RatePercent may be specified. PriceLevelId and PriceLevelName are ONLY available for QBXMLVersions 4.0 and above. You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.) The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders. Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the Rate, which was set using the price level. |
Quantity String |
Line item field: Quantity of item or item group. The quantity of the Item specified in this line. If Quantity and only one of Cost, Rate, or Amount are specified, QuickBooks will automatically calculate the other. This field is a String type in order to allow setting fractional quantities. Setting this field with non-numeric data will cause an error. Correct usage of this field is shown below:
Leave this field blank and no quantity will be sent to QuickBooks. |
Rate String |
Unit rate of item. The unit rate charged for this item. If Amount is specified, then Rate will be calculated automatically and should not be specified. The amount should be formatted as a string in dollars. |
RatePercent String |
Line item field: A markup or discount percentage. If RatePercent is specified instead of Rate, then this line item represents a percentage markup or discount, to be applied to the previous Item or Item group. RatePercent should be formatted as a positive or negative integer; a positive value indicates a markup. Only one of RatePercent and Rate may be specified. If RatePercent is set, then Rate will be set to its default. |
ServiceDate String |
Line item field: Date of service. For Items that represent a service, ServiceDate refers to the date of service. ServiceDate is only applicable for the CreditMemo, Invoice, PurchaseOrder, and SalesReceipt classs. The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format. When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format. |
TaxCodeId String |
Line item field: Sales tax information for this item. This is a reference to a sales tax code predefined within QuickBooks. By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes. Id/Name Reference Properties This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined. Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined. Setting the value of this property will set the corresponding Name property to an empty string. |
TaxCodeName String |
Line item field: Sales tax information for this item. This is a reference to a sales tax code predefined within QuickBooks. By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes. Name/Id Reference Properties This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field. Setting the value of this property will set the corresponding Id property to an empty string. |
UnitOfMeasure String |
Unit of measure describing the Quantity. In a transaction line item, the name of the unit of measure selected from within the item's available units. If the company file is enabled only for single unit of measure per item, this must be the base unit! This field is only available for QBXMLVersion 7.0 and higher. |
Constructors
public LineItem();
Config Settings (Lineitemgroups Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.Base Config Settings |
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. |
GUIAvailable:
Tells the class whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events. |
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
UseDaemonThreads: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. |
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms. |
Trappable Errors (Lineitemgroups Class)
LineItemGroups Errors
201 A required field was not specified. | |
421 Update is not supported for this GroupType. | |
901 Unable to parse aggregate. | |
902 Invalid GroupType. |