CSharp API - Revision history

Dina at 10:27, 9 July 2020

2020-07-09T10:27:49Z

← Older revision		Revision as of 10:27, 9 July 2020
Line 158:		Line 158:
	</font>		</font>

	Тhe first parameter to the '''AddCriteria''' method is either a static object instance of '''CRM.~~CmtField~~''' class representing the field we want to look in or the internal API field name. Refer to the '''API Field Name''' column in the [[CSharp_API#Account_Class\|Account Class]]		Тhe first parameter to the '''AddCriteria''' method is either a static object instance of '''CRM.CrmField''' class representing the field we want to look in or the internal API field name. Refer to the '''API Field Name''' column in the [[CSharp_API#Account_Class\|Account Class]]
	table for a complete list of the available fields for the '''CRM.Account''' class.		table for a complete list of the available fields for the '''CRM.Account''' class.

Line 2,808:		Line 2,808:
	\|}		\|}

	== ~~CmtField~~ Class ==		== CrmField Class ==

	The '''CRM.~~CmtField~~''' class holds the basic attributes for each database field. For each of the classes that represent RangerMSP objects (Account, Ticket, etc.) there is a preinitialized set of shared '''CRM.~~CmtField~~''' objects that correspond to the properties defined for the class. For example, the '''CRM.Account''' class has a property '''FileAs''' ('''CRM.Account.FileAs'''). To this property corresponds one shared object instance of the '''CRM.~~CmtField~~''' class accessible through '''CRM.Account.Fields.FileAs'''. To the property '''LastName''' ('''CRM.Account.LastName'''), corresponds the shared object '''CRM.Account.Fields.LastName''' of type '''CRM.~~CmtField~~'''. And so on, for each property in each class.		The '''CRM.CrmField''' class holds the basic attributes for each database field. For each of the classes that represent RangerMSP objects (Account, Ticket, etc.) there is a preinitialized set of shared '''CRM.CrmField''' objects that correspond to the properties defined for the class. For example, the '''CRM.Account''' class has a property '''FileAs''' ('''CRM.Account.FileAs'''). To this property corresponds one shared object instance of the '''CRM.CrmField''' class accessible through '''CRM.Account.Fields.FileAs'''. To the property '''LastName''' ('''CRM.Account.LastName'''), corresponds the shared object '''CRM.Account.Fields.LastName''' of type '''CRM.CrmField'''. And so on, for each property in each class.

	Below is a table that lists the properties available in the '''CRM.~~CmtField~~''' class.		Below is a table that lists the properties available in the '''CRM.CrmField''' class.

	{\| class="wikitable"		{\| class="wikitable"
Line 2,917:		Line 2,917:
	\| void		\| void
	\| '''AddCriteria'''		\| '''AddCriteria'''
	\| (~~CmtField~~ field, OperatorEnum opEnum, string sValue)		\| (CrmField field, OperatorEnum opEnum, string sValue)
	\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.		\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.
	First parameter is one of the '''CRM.~~CmtField~~''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,		First parameter is one of the '''CRM.CrmField''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,
	second parameter is the criteria operator (see the table below)		second parameter is the criteria operator (see the table below)
	and third parameter is the value ('''System.String''') to search for. This variation (or the one variations with the '''System.DateTime''' or '''System.Double''' as third parameter) of the '''AddCriteria''' method is the preferred way of adding criteria, unless there is no preinitialized '''CRM.~~CmtField~~''' object for the field.		and third parameter is the value ('''System.String''') to search for. This variation (or the one variations with the '''System.DateTime''' or '''System.Double''' as third parameter) of the '''AddCriteria''' method is the preferred way of adding criteria, unless there is no preinitialized '''CRM.CrmField''' object for the field.
	\|-		\|-
	\| public		\| public
	\| void		\| void
	\| '''AddCriteria'''		\| '''AddCriteria'''
	\| (~~CmtField~~ field, OperatorEnum opEnum, DateTime dtValue)		\| (CrmField field, OperatorEnum opEnum, DateTime dtValue)
	\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.		\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.
	First parameter is one of the '''CRM.~~CmtField~~''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,		First parameter is one of the '''CRM.CrmField''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,
	second parameter is the criteria operator (see the table below)		second parameter is the criteria operator (see the table below)
	and third parameter is the value ('''System.DateTime''') to search for. Use this variation to search in fields that are of '''DateTime''' type.		and third parameter is the value ('''System.DateTime''') to search for. Use this variation to search in fields that are of '''DateTime''' type.
Line 2,935:		Line 2,935:
	\| void		\| void
	\| '''AddCriteria'''		\| '''AddCriteria'''
	\| (~~CmtField~~ field, OperatorEnum opEnum, int nValue)		\| (CrmField field, OperatorEnum opEnum, int nValue)
	\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.		\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.
	First parameter is one of the '''CRM.~~CmtField~~''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,		First parameter is one of the '''CRM.CrmField''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,
	second parameter is the criteria operator (see the table below)		second parameter is the criteria operator (see the table below)
	and third parameter is the value ('''System.Integer''') to search for. Use this variation to search in fields that are of '''Integer''' type.		and third parameter is the value ('''System.Integer''') to search for. Use this variation to search in fields that are of '''Integer''' type.
Line 2,944:		Line 2,944:
	\| void		\| void
	\| '''AddCriteria'''		\| '''AddCriteria'''
	\| (~~CmtField~~ field, OperatorEnum opEnum, double nValue)		\| (CrmField field, OperatorEnum opEnum, double nValue)
	\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.		\| Adds one criteria to the initialized '''CRM.ObjectQuery''' object instance.
	First parameter is one of the '''CRM.~~CmtField~~''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,		First parameter is one of the '''CRM.CrmField''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,
	second parameter is the criteria operator (see the table below)		second parameter is the criteria operator (see the table below)
	and third parameter is the value ('''System.Double''') to search for. Use this variation to search in fields that are of '''Double''' type.		and third parameter is the value ('''System.Double''') to search for. Use this variation to search in fields that are of '''Double''' type.
Line 2,961:		Line 2,961:
	\| void		\| void
	\| '''AddSortExpression'''		\| '''AddSortExpression'''
	\| (~~CmtField~~ field, SortDirectionEnum sortEnum)		\| (CrmField field, SortDirectionEnum sortEnum)
	\| Adds a sort expression to the initialized '''CRM.ObjectQuery''' object instance.		\| Adds a sort expression to the initialized '''CRM.ObjectQuery''' object instance.
	First parameter is one of the '''CRM.~~CmtField~~''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,		First parameter is one of the '''CRM.CrmField''' preinitialized objects included in Fields class in each of the '''CRM.Object''' derived classes,
	second parameter is '''CRM.SortDirectionEnum''' ('''sortASC''' or '''sortDESC''').		second parameter is '''CRM.SortDirectionEnum''' ('''sortASC''' or '''sortDESC''').
	\|-		\|-

Dina at 08:02, 8 July 2020

2020-07-08T08:02:33Z

Show changes

Dina at 18:29, 21 March 2020

2020-03-21T18:29:54Z

← Older revision		Revision as of 18:29, 21 March 2020
Line 3,031:		Line 3,031:

	= See Also =		= See Also =
	*[[~~Commit~~ API Developers Guide]]		*[[API Developers Guide]]
	*[[API Reference Manual]]		*[[API Reference Manual]]
	[[Category:User Manuals]]		[[Category:User Manuals]]
	[[Category:Integration]]		[[Category:Integration]]

Dina at 17:10, 21 March 2020

2020-03-21T17:10:28Z

← Older revision		Revision as of 17:10, 21 March 2020
Line 158:		Line 158:
	</font>		</font>

	Тhe first parameter to the '''AddCriteria''' method is either a static object instance of '''CommitCRM.CmtField''' class representing the field we want to look in or the internal API field name. Refer to the '''API Field Name''' column in the [[~~CommitCRM_CSharp_API~~#Account_Class\|Account Class]]		Тhe first parameter to the '''AddCriteria''' method is either a static object instance of '''CommitCRM.CmtField''' class representing the field we want to look in or the internal API field name. Refer to the '''API Field Name''' column in the [[CSharp_API#Account_Class\|Account Class]]
	table for a complete list of the available fields for the '''CommitCRM.Account''' class.		table for a complete list of the available fields for the '''CommitCRM.Account''' class.

Line 231:		Line 231:
	</font>		</font>

	All internal field names are listed in [[~~CommitCRM_CSharp_API~~#Classes_and_Objects\|Classes and Objects]] below.		All internal field names are listed in [[CSharp_API#Classes_and_Objects\|Classes and Objects]] below.

	= Exception Handling =		= Exception Handling =

Dina: Dina moved page CommitCRM CSharp API to CSharp API

2020-03-21T17:09:20Z

Dina moved page CommitCRM CSharp API to CSharp API

← Older revision	Revision as of 17:09, 21 March 2020
(No difference)

Dina: /* Charge Class */

2018-06-11T10:42:03Z

Charge Class

← Older revision		Revision as of 10:42, 11 June 2018
Line 1,462:		Line 1,462:
	\| FLDSLPADJUSTPERCENT		\| FLDSLPADJUSTPERCENT
	\| N/A		\| N/A
			\|-
			\| public
			\| string
			\| '''AdjustType'''
			\| FLDSLPADJUSTTYPE
			\| 1
	\|-		\|-
	\| public		\| public
Line 1,506:		Line 1,512:
	\|}		\|}



	=== Quote Class ===		=== Quote Class ===

Goran: /* ObjectQuery Class */

2015-03-20T08:36:01Z

ObjectQuery Class

← Older revision		Revision as of 08:36, 20 March 2015
Line 2,874:		Line 2,874:

	<font face="courier new" size="3">		<font face="courier new" size="3">
	CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>> accountSearch = <span style="color: #3A3AFF;">new</span> CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>>();		CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>> accountSearch = <span style="color: #3A3AFF;">new</span> CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>>(CommitCRM.LinkEnum.linkOR);
	accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"New York"</span>);		accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"New York"</span>);
	accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"Chicago"</span>);		accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"Chicago"</span>);
Line 2,884:		Line 2,884:

	<font face="courier new" size="3">		<font face="courier new" size="3">
	CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>> accountSearch = <span style="color: #3A3AFF;">new</span> CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>>();		CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>> accountSearch = <span style="color: #3A3AFF;">new</span> CommitCRM.<span style="color: #2B91AF;">ObjectQuery</span><CommitCRM.<span style="color: #2B91AF;">Account</span>>(CommitCRM.LinkEnum.linkOR);
	accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"New York"</span>);		accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"New York"</span>);
	accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"Chicago"</span>);		accountSearch.AddCriteria(CommitCRM.<span style="color: #2B91AF;">Account</span>.<span style="color: #2B91AF;">Fields</span>.City, CommitCRM.<span style="color: #2B91AF;">OperatorEnum</span>.opEqual, <span style="color: #963A46;">"Chicago"</span>);

Goran: /* ObjectQuery Class */

2015-03-20T07:46:34Z

ObjectQuery Class

@@ Line 2,867: / Line 2,867: @@
   <span style="color: #2B91AF;">List</span><CommitCRM.<span style="color: #2B91AF;">Ticket</span>> tickets = ticketSearch.FetchObjects();
   <span style="color: #66AD3A;">//tickets now contains all CommitCRM.Ticket objects that satisfy the above criteria.</span>
 </font>

Goran: /* Task Class */

2014-04-17T10:20:15Z

Task Class

← Older revision		Revision as of 10:20, 17 April 2014
Line 1,326:		Line 1,326:
	\| '''TimeStart'''		\| '''TimeStart'''
	\| FLDEVTFROMTIME		\| FLDEVTFROMTIME
	~~\| N/A~~
	\|-
	~~\| public~~
	~~\| string~~
	~~\| '''TimeEnd'''~~
	~~\| FLDEVTTOTIME~~
	\| N/A		\| N/A
	\|-		\|-

Goran: /* Calendar Class */

2014-04-16T15:30:31Z

Calendar Class

@@ Line 1,115: / Line 1,115: @@
 === Calendar Class ===
-The '''CommitCRM.Calendar''' class derives from '''CommitCRM.Object''' and encapsulates the [[API_Reference_Manual#Calendar_Fields|Calendar Fields]].
+The '''CommitCRM.Calendar''' class derives from '''CommitCRM.Object''' and encapsulates the [[API_Reference_Manual#Calendar_Fields|Calendar Fields]] of event type Appointment.
 The following table lists all exposed '''CommitCRM.Calendar''' properties.
@@ Line 1,130: / Line 1,130: @@
 | string
 | '''CalendarREC_ID'''
 | FLDEVTRECID
 | 20