Class NSSelectionAgent
Selections, entities, members and tasks
NSSelectionAgent agent;
agent.callMethod(arg1, arg2);Syntax
Examples
NSSelectionAgent agent;
agent.callMethod(arg1, arg2);Constructors
NSSelectionAgent()
Selections, entities, members and tasks
NSSelectionAgent agent;
agent.callMethod(arg1, arg2);Introduced or updated in version: 7
Declaration
NSSelectionAgentExamples
NSSelectionAgent agent;
agent.callMethod(arg1, arg2);Methods
AddContactSelectionMembers(Integer,NSContactPersonId[])
Adds the collection of ContactPersonId as members to the static selection
Introduced or updated in version: 7
Declaration
Void AddContactSelectionMembers(Integer selectionId, NSContactPersonId[] contactPersonIds)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| contactPersonIds |
Returns
| Type | Description |
|---|---|
| Void |
AddContactSelectionMembersFromSearch(Integer,String)
Adds members to the selection from the search result.
Introduced or updated in version: 7
Declaration
Integer AddContactSelectionMembersFromSearch(Integer selectionId, String storageKey)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | storageKey |
Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.AddContactSelectionMembersFromSearch(selectionId, storageKey);AddRemoveContactSelectionMemberInterests(Integer,Integer[],Integer[],Integer[],Integer[])
Adds or removes interests on companies and persons in a selection.
Introduced or updated in version: 7
Declaration
Void AddRemoveContactSelectionMemberInterests(Integer selectionId, Integer[] addCompanyInterests, Integer[] removeCompanyInterests, Integer[] addContactInterests, Integer[] removeContactInterests)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| Integer[] | addCompanyInterests | |
| Integer[] | removeCompanyInterests | |
| Integer[] | addContactInterests | |
| Integer[] | removeContactInterests |
Returns
| Type | Description |
|---|---|
| Void |
AddSelectionMembers(Integer,Integer[])
Add selection members to a static selection of type others than contacts.
Introduced or updated in version: 7
Declaration
Integer AddSelectionMembers(Integer selectionId, Integer[] ids)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| Integer[] | ids |
Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionAgent agent;
Integer selectionId;
Integer[] ids;
Integer res = agent.AddSelectionMembers(selectionId, ids);AddSelectionMembersFromSearch(Integer,String)
Adds members from the selection using the search result.
Introduced or updated in version: 7
Declaration
Integer AddSelectionMembersFromSearch(Integer selectionId, String storageKey)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | storageKey |
Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.AddSelectionMembersFromSearch(selectionId, storageKey);CopyContactSelectionMembers(Integer,Integer)
Copies contact selection members from selection into an existing selection.
Introduced or updated in version: 7
Declaration
Void CopyContactSelectionMembers(Integer fromSelectionId, Integer toSelectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | fromSelectionId | |
| Integer | toSelectionId |
Returns
| Type | Description |
|---|---|
| Void |
CopySelectionMembers(Integer,Integer)
Copies selection members from selection into an existing selection.
Introduced or updated in version: 7
Declaration
Void CopySelectionMembers(Integer fromSelectionId, Integer toSelectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | fromSelectionId | |
| Integer | toSelectionId |
Returns
| Type | Description |
|---|---|
| Void |
CreateContactSelectionFromSelection(Integer,String,Integer,Bool)
Creates a new selection based on selection members from an existing selection.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateContactSelectionFromSelection(Integer selectionId, String name, Integer targetSelectionType, Bool copyMembers)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | name | |
| Integer | targetSelectionType | See SelectionType |
| Bool | copyMembers |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
Integer selectionId;
String name;
Integer targetSelectionType;
Bool copyMembers;
NSSelectionEntity res = agent.CreateContactSelectionFromSelection(selectionId, name, targetSelectionType, copyMembers);CreateContactSelectionFromShadowSelection(Integer,String)
Creates a new contact selection based on contact selection members from an existing shadow sale, appointment, project or document selection.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateContactSelectionFromShadowSelection(Integer selectionId, String name)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | name |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Remarks
The new selection will always be static even if the original selection is dynamic.
Examples
NSSelectionAgent agent;
Integer selectionId;
String name;
NSSelectionEntity res = agent.CreateContactSelectionFromShadowSelection(selectionId, name);CreateDefaultMailMergeSettings()
Sets default values into a new NSMailMergeSettings.
Introduced or updated in version: 7
Declaration
NSMailMergeSettings CreateDefaultMailMergeSettings()Returns
| Type | Description |
|---|---|
| NSMailMergeSettings |
Remarks
NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
Examples
NSSelectionAgent agent;
NSMailMergeSettings thing = agent.CreateDefaultMailMergeSettings();
thing = agent.SaveMailMergeSettings(thing);CreateDefaultMailMergeTask()
Sets default values into a new NSMailMergeTask.
Introduced or updated in version: 7
Declaration
NSMailMergeTask CreateDefaultMailMergeTask()Returns
| Type | Description |
|---|---|
| NSMailMergeTask |
Remarks
NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
Examples
NSSelectionAgent agent;
NSMailMergeTask thing = agent.CreateDefaultMailMergeTask();
thing = agent.SaveMailMergeTask(thing);CreateDefaultSelectionEntity()
Sets default values into a new NSSelectionEntity.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateDefaultSelectionEntity()Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Remarks
NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
Examples
NSSelectionAgent agent;
NSSelectionEntity thing = agent.CreateDefaultSelectionEntity();
thing = agent.SaveSelectionEntity(thing);CreateNewEntry(NSDuplicateEntry)
Creates a new selection based on external duplicate
Introduced or updated in version: 7
Declaration
Integer CreateNewEntry(NSDuplicateEntry duplicate)Parameters
| Type | Name | Description |
|---|---|---|
| NSDuplicateEntry | duplicate |
Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionAgent agent;
NSDuplicateEntry duplicate;
Integer res = agent.CreateNewEntry(duplicate);CreateSelectionEntity(String)
Creates (but do not save) a new selection entity, for the current user and the given target table; other fields populated as by CreateDefaultSelectionEntity()
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateSelectionEntity(String targetTableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | targetTableName |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
String targetTableName;
NSSelectionEntity res = agent.CreateSelectionEntity(targetTableName);CreateSelectionFromSelection(Integer,String,Integer,Bool)
Creates a new selection based on selection members from an existing selection.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateSelectionFromSelection(Integer selectionId, String name, Integer targetSelectionType, Bool copyMembers)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | name | |
| Integer | targetSelectionType | See SelectionType |
| Bool | copyMembers |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
Integer selectionId;
String name;
Integer targetSelectionType;
Bool copyMembers;
NSSelectionEntity res = agent.CreateSelectionFromSelection(selectionId, name, targetSelectionType, copyMembers);CreateTemporaryContactSelection()
Creates a temporary selection.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateTemporaryContactSelection()Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
NSSelectionEntity res = agent.CreateTemporaryContactSelection();CreateTemporaryContactSelectionFromContactPersonIds(NSContactPersonId[])
Creates a temporary selection with members from a collection of ContactPerson IDs.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateTemporaryContactSelectionFromContactPersonIds(NSContactPersonId[] contactPersonIds)Parameters
| Type | Name | Description |
|---|---|---|
| contactPersonIds |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
NSContactPersonId[] contactPersonIds;
NSSelectionEntity res = agent.CreateTemporaryContactSelectionFromContactPersonIds(contactPersonIds);CreateTemporaryContactSelectionFromProjectMembers(Integer)
Creates a temporary selection with members from an existing project.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateTemporaryContactSelectionFromProjectMembers(Integer projectId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | projectId |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
Integer projectId;
NSSelectionEntity res = agent.CreateTemporaryContactSelectionFromProjectMembers(projectId);CreateTemporaryContactSelectionFromSelectionMemberIds(Integer,Integer[])
Creates a temporary selection with members from a collection of selection-member IDs.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateTemporaryContactSelectionFromSelectionMemberIds(Integer selectionId, Integer[] selectionMemberIds)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| Integer[] | selectionMemberIds |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
Integer selectionId;
Integer[] selectionMemberIds;
NSSelectionEntity res = agent.CreateTemporaryContactSelectionFromSelectionMemberIds(selectionId, selectionMemberIds);CreateTemporarySelectionFromIds(Integer[],Integer)
Creates a temporary selection with members from a collection of entity IDs.
Introduced or updated in version: 7
Declaration
NSSelectionEntity CreateTemporarySelectionFromIds(Integer[] ids, Integer targetTableNumber)Parameters
| Type | Name | Description |
|---|---|---|
| Integer[] | ids | |
| Integer | targetTableNumber |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
Integer[] ids;
Integer targetTableNumber;
NSSelectionEntity res = agent.CreateTemporarySelectionFromIds(ids, targetTableNumber);DeleteContacts(Integer)
Deletes all contacts from a selection.
Introduced or updated in version: 7
Declaration
Void DeleteContacts(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
If a contact does not have delete rights, it will be skipped.
DeleteEntities(Integer)
Deletes all entities from a selection.
Introduced or updated in version: 7
Declaration
Void DeleteEntities(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
If an entity does not have delete rights, it will be skipped.
DeletePersons(Integer)
Deletes all persons from a selection.
Introduced or updated in version: 8.5R08
Declaration
Void DeletePersons(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
If a person does not have delete rights, it will be skipped.
DeleteSelectionEntity(Integer)
Deletes the NSSelectionEntity
Introduced or updated in version: 7
Declaration
DeleteSelectionEntity(Integer selectionEntity)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionEntity |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSSelectionAgent agent;
agent.DeleteSelectionEntity(123);EditContactSelectionMemberDetails(Integer,NSSelectionMemberEditValues)
Edits company and contact details in a selection based on contents in selectionMemberEditValues.
Introduced or updated in version: 7
Declaration
Void EditContactSelectionMemberDetails(Integer selectionId, NSSelectionMemberEditValues selectionMemberEditValues)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| selectionMemberEditValues |
Returns
| Type | Description |
|---|---|
| Void |
ExportSelectionMembers(Integer,String,Bool)
Generates a string that is the result of substituting the template variables with values from selection members.
Introduced or updated in version: 7
Declaration
Byte[] ExportSelectionMembers(Integer selectionId, String templateName, Bool useContacts)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | templateName | |
| Bool | useContacts |
Returns
| Type | Description |
|---|---|
| Byte[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
String templateName;
Bool useContacts;
Byte[] res = agent.ExportSelectionMembers(selectionId, templateName, useContacts);ExportSelectionMembersWithOrderBy(Integer,String,Bool,String)
Generates a string that is the result of substituting the template variables with values from selection members.
Introduced or updated in version: 8.2
Declaration
Byte[] ExportSelectionMembersWithOrderBy(Integer selectionId, String templateName, Bool useContacts, String orderBy)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | templateName | |
| Bool | useContacts | |
| String | orderBy |
Returns
| Type | Description |
|---|---|
| Byte[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
String templateName;
Bool useContacts;
String orderBy;
Byte[] res = agent.ExportSelectionMembersWithOrderBy(selectionId, templateName, useContacts, orderBy);GenerateFollowUps(Integer,NSAppointmentEntity,Integer,Bool,Bool)
Generates follow-ups for members in the selection.
Introduced or updated in version: 7
Declaration
Void GenerateFollowUps(Integer selectionId, NSAppointmentEntity appointmentEntity, Integer associateId, Bool saveOnContactOwner, Bool uniqueContact)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| appointmentEntity | ||
| Integer | associateId | |
| Bool | saveOnContactOwner | |
| Bool | uniqueContact |
Returns
| Type | Description |
|---|---|
| Void |
GetDuplicateRules()
Retrieves all available duplicate rules for selection
Introduced or updated in version: 7
Declaration
NSDuplicateRule[] GetDuplicateRules()Returns
| Type | Description |
|---|---|
| NSDuplicateRule[] |
Examples
NSSelectionAgent agent;
NSDuplicateRule[] res = agent.GetDuplicateRules();GetDuplicates(String)
Gets duplicates(exact or similar in the database) based on the name
Introduced or updated in version: 7
Declaration
NSDuplicateEntry[] GetDuplicates(String name)Parameters
| Type | Name | Description |
|---|---|---|
| String | name |
Returns
| Type | Description |
|---|---|
| NSDuplicateEntry[] |
Examples
NSSelectionAgent agent;
String name;
NSDuplicateEntry[] res = agent.GetDuplicates(name);GetDynamicSelectionCriteria(Integer)
Gets the criteria for this dynamic selection.
Introduced or updated in version: 8.2
Declaration
NSArchiveRestrictionInfo[] GetDynamicSelectionCriteria(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId |
Returns
| Type | Description |
|---|---|
| NSArchiveRestrictionInfo[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionInfo[] res = agent.GetDynamicSelectionCriteria(selectionId);GetDynamicSelectionCriteriaGroups(Integer)
Gets the criteria for this dynamic selection. This call supports multiple criteria groups.
Introduced or updated in version: 7
Declaration
NSArchiveRestrictionGroup[] GetDynamicSelectionCriteriaGroups(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId |
Returns
| Type | Description |
|---|---|
| NSArchiveRestrictionGroup[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionGroup[] res = agent.GetDynamicSelectionCriteriaGroups(selectionId);GetParentCombinedSelections(Integer)
Gets a list of all selection ids where the given selection is used to create a combined selection.
Introduced or updated in version: 7
Declaration
Integer[] GetParentCombinedSelections(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId |
Returns
| Type | Description |
|---|---|
| Integer[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
Integer[] res = agent.GetParentCombinedSelections(selectionId);GetRecipientStatistics(Integer)
Returns an NSRecipientStatistics object with a count of addresses and email addresses.
Introduced or updated in version: 7
Declaration
NSRecipientStatistics GetRecipientStatistics(Integer selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId |
Returns
| Type | Description |
|---|---|
| NSRecipientStatistics |
Examples
NSSelectionAgent agent;
Integer selectionId;
NSRecipientStatistics res = agent.GetRecipientStatistics(selectionId);GetRecipientStatisticsFromContactPersonIds()
Returns an NSRecipientStatistics object with a count of addresses and email addresses based on contact and persons in a collection of ContactPersonId.
Introduced or updated in version: 7
Declaration
NSRecipientStatistics GetRecipientStatisticsFromContactPersonIds(NSContactPersonId[] contactPersonIds)Returns
| Type | Description |
|---|---|
| NSRecipientStatistics |
Examples
NSSelectionAgent agent;
NSContactPersonId[] contactPersonIds;
NSRecipientStatistics res = agent.GetRecipientStatisticsFromContactPersonIds(contactPersonIds);GetRecipientStatisticsFromProjectMembers(Integer)
Returns an NSRecipientStatistics object with a count of addresses and email addresses based on members in a project.
Introduced or updated in version: 7
Declaration
NSRecipientStatistics GetRecipientStatisticsFromProjectMembers(Integer projectId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | projectId |
Returns
| Type | Description |
|---|---|
| NSRecipientStatistics |
Examples
NSSelectionAgent agent;
Integer projectId;
NSRecipientStatistics res = agent.GetRecipientStatisticsFromProjectMembers(projectId);GetSelectionEntity(Integer)
Gets an NSSelectionEntity object.
Introduced or updated in version: 7
Declaration
NSSelectionEntity GetSelectionEntity(Integer selectionEntityId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionEntityId |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity |
Examples
NSSelectionAgent agent;
NSSelectionEntity thing = agent.GetSelectionEntity(123);GetSelectionForFind(String,Integer)
Obtains a selection for the given entity, for the current user, of type WorkingSetForFind.
Introduced or updated in version: 7
Declaration
NSSelectionForFind GetSelectionForFind(String entityName, Integer typicalSearchId)Parameters
| Type | Name | Description |
|---|---|---|
| String | entityName | |
| Integer | typicalSearchId | Optionally populate criteria from the TypicalSearches system. |
Returns
| Type | Description |
|---|---|
| NSSelectionForFind |
Examples
NSSelectionAgent agent;
String entityName;
Integer typicalSearchId;
NSSelectionForFind res = agent.GetSelectionForFind(entityName, typicalSearchId);GetSelectionMembersArchiveRows(Integer,String)
Gets the list of members in this selection. The type of members depends on the target table of the selection.
Introduced or updated in version: 8.2
Declaration
NSArchiveListItem[] GetSelectionMembersArchiveRows(Integer selectionId, String select)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | select |
Returns
| Type | Description |
|---|---|
| NSArchiveListItem[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
String select;
NSArchiveListItem[] res = agent.GetSelectionMembersArchiveRows(selectionId, select);GetSelectionShadowMembersArchiveRows(Integer,String)
Gets the list of members in this selection's shadow (i.e. the list of contacts + persons referenced in the main selection).
Introduced or updated in version: 8.2
Declaration
NSArchiveListItem[] GetSelectionShadowMembersArchiveRows(Integer selectionId, String select)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | select |
Returns
| Type | Description |
|---|---|
| NSArchiveListItem[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
String select;
NSArchiveListItem[] res = agent.GetSelectionShadowMembersArchiveRows(selectionId, select);RemoveContactSelectionMembers(Integer,NSContactPersonId[])
Removes members from the selection as specified in the collection of ContactPersonId.
Introduced or updated in version: 7
Declaration
Void RemoveContactSelectionMembers(Integer selectionId, NSContactPersonId[] contactPersonIds)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| contactPersonIds |
Returns
| Type | Description |
|---|---|
| Void |
RemoveContactSelectionMembersFromIds(Integer,Integer[])
Removes members from the selection using a collection a selection-member IDs.
Introduced or updated in version: 7
Declaration
Void RemoveContactSelectionMembersFromIds(Integer selectionId, Integer[] selectionMembersIds)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| Integer[] | selectionMembersIds |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
Members can only be removed from single selection.
RemoveContactSelectionMembersFromSearch(Integer,String)
Removes members from the selection using the search result.
Introduced or updated in version: 7
Declaration
Integer RemoveContactSelectionMembersFromSearch(Integer selectionId, String storageKey)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | storageKey |
Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.RemoveContactSelectionMembersFromSearch(selectionId, storageKey);RemoveSelectionMembers(Integer,Integer[])
Removes members from the selection as specified in the collection of entity IDs. The IDs are selection member IDs (selection member primary key)
Introduced or updated in version: 7
Declaration
Void RemoveSelectionMembers(Integer selectionId, Integer[] selectionMemberIds)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| Integer[] | selectionMemberIds |
Returns
| Type | Description |
|---|---|
| Void |
RemoveSelectionMembersById(Integer,Integer[])
Removes members from the selection as specified in the collection of entity IDs. The IDs can be a collection of sale IDs, or other supported types.
Introduced or updated in version: 8.2
Declaration
Void RemoveSelectionMembersById(Integer selectionId, Integer[] ids)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| Integer[] | ids |
Returns
| Type | Description |
|---|---|
| Void |
RemoveSelectionMembersFromSearch(Integer,String)
Removes members from the selection using the search result.
Introduced or updated in version: 7
Declaration
Integer RemoveSelectionMembersFromSearch(Integer selectionId, String storageKey)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | storageKey |
Returns
| Type | Description |
|---|---|
| Integer |
Examples
NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.RemoveSelectionMembersFromSearch(selectionId, storageKey);SaveSelectionEntity(NSSelectionEntity)
Updates the existing NSSelectionEntity or creates a new NSSelectionEntity if the ID parameter is 0.
Introduced or updated in version: 7
Declaration
NSSelectionEntity SaveSelectionEntity(NSSelectionEntity selectionEntity)Parameters
| Type | Name | Description |
|---|---|---|
| NSSelectionEntity | selectionEntity | The entity to save. |
Returns
| Type | Description |
|---|---|
| NSSelectionEntity | The new or updated NSSelectionEntity. |
Examples
NSSelection agent;
NSSelectionEntity thing = agent.CreateDefaultSelectionEntity();
thing = agent.SaveSelectionEntity(thing);SetDuplicateRulesStatus(NSDuplicateRule[])
Sets which duplicate rules should be active or not
Introduced or updated in version: 7
Declaration
Void SetDuplicateRulesStatus(NSDuplicateRule[] rules)Parameters
| Type | Name | Description |
|---|---|---|
| NSDuplicateRule[] | rules |
Returns
| Type | Description |
|---|---|
| Void |
SetDynamicSelectionCriteria(Integer,NSArchiveRestrictionInfo[])
Updates the criteria for this dynamic selection. Replaces existing criteria with the new values.
Introduced or updated in version: 8.2
Declaration
NSArchiveRestrictionInfo[] SetDynamicSelectionCriteria(Integer selectionId, NSArchiveRestrictionInfo[] criteria)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| NSArchiveRestrictionInfo[] | criteria |
Returns
| Type | Description |
|---|---|
| NSArchiveRestrictionInfo[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionInfo[] criteria;
NSArchiveRestrictionInfo[] res = agent.SetDynamicSelectionCriteria(selectionId, criteria);SetDynamicSelectionCriteria2(Integer,String)
Updates the criteria for this dynamic selection using string.
Introduced or updated in version: 8.2
Declaration
NSArchiveRestrictionInfo[] SetDynamicSelectionCriteria2(Integer selectionId, String filter)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| String | filter |
Returns
| Type | Description |
|---|---|
| NSArchiveRestrictionInfo[] |
Remarks
Criteria are parsed from the OData filter form: ''name startswith 'foo' and category in (1,2,3)''n
Examples
NSSelectionAgent agent;
Integer selectionId;
String filter;
NSArchiveRestrictionInfo[] res = agent.SetDynamicSelectionCriteria2(selectionId, filter);SetDynamicSelectionCriteria3(Integer,NSArchiveRestrictionInfo[],String)
Updates the criteria for this dynamic selection. Use criteria as either restriction objects or OData string format.
Introduced or updated in version: 8.2
Declaration
NSArchiveRestrictionInfo[] SetDynamicSelectionCriteria3(Integer selectionId, NSArchiveRestrictionInfo[] criteria, String filter)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| NSArchiveRestrictionInfo[] | criteria | |
| String | filter |
Returns
| Type | Description |
|---|---|
| NSArchiveRestrictionInfo[] |
Remarks
Criteria are parsed from the OData filter form: ''name startswith 'foo' and category in (1,2,3)''n
Examples
NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionInfo[] criteria;
String filter;
NSArchiveRestrictionInfo[] res = agent.SetDynamicSelectionCriteria3(selectionId, criteria, filter);SetDynamicSelectionCriteriaGroups(Integer,NSArchiveRestrictionGroup[])
Updates the criteria for this dynamic selection. Replaces existing criteria with the new values. This call supports multiple criteria groups.
Introduced or updated in version: 7
Declaration
NSArchiveRestrictionGroup[] SetDynamicSelectionCriteriaGroups(Integer selectionId, NSArchiveRestrictionGroup[] criteria)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | selectionId | |
| NSArchiveRestrictionGroup[] | criteria |
Returns
| Type | Description |
|---|---|
| NSArchiveRestrictionGroup[] |
Examples
NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionGroup[] criteria;
NSArchiveRestrictionGroup[] res = agent.SetDynamicSelectionCriteriaGroups(selectionId, criteria);StartMailMerge(MailMergeSettings)
Starts a mail-merge operation with specified settings.
Introduced or updated in version: 7
Declaration
Void StartMailMerge(MailMergeSettings settings)Parameters
| Type | Name | Description |
|---|---|---|
| settings |
Returns
| Type | Description |
|---|---|
| Void |
UpdateTypicalSearch(NSTypicalSearches)
Updates (imports) TypicalSearch information in the database
Introduced or updated in version: 7
Declaration
String UpdateTypicalSearch(NSTypicalSearches searches)Parameters
| Type | Name | Description |
|---|---|---|
| searches |
Returns
| Type | Description |
|---|---|
| String |
Examples
NSSelectionAgent agent;
NSTypicalSearches searches;
String res = agent.UpdateTypicalSearch(searches);