Class NSSelectionAgent

NSSelectionAgent()

Selections, entities, members and tasks

NSSelectionAgent agent;
agent.callMethod(arg1, arg2);

Declaration

NSSelectionAgent

NSSelectionAgent agent;
agent.callMethod(arg1, arg2);

AddContactSelectionMembers(Integer,NSContactPersonId[])

Adds the collection of ContactPersonId as members to the static selection

Declaration

Void AddContactSelectionMembers(Integer selectionId, NSContactPersonId[] contactPersonIds)

Parameters

Returns

AddContactSelectionMembersFromSearch(Integer,String)

Adds members to the selection from the search result.

Declaration

Integer AddContactSelectionMembersFromSearch(Integer selectionId, String storageKey)

NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.AddContactSelectionMembersFromSearch(selectionId, storageKey);

Parameters

Returns

AddRemoveContactSelectionMemberInterests(Integer,Integer[],Integer[],Integer[],Integer[])

Adds or removes interests on companies and persons in a selection.

Declaration

Void AddRemoveContactSelectionMemberInterests(Integer selectionId, Integer[] addCompanyInterests, Integer[] removeCompanyInterests, Integer[] addContactInterests, Integer[] removeContactInterests)

Parameters

Returns

AddSelectionMembers(Integer,Integer[])

Add selection members to a static selection of type others than contacts.

Declaration

Integer AddSelectionMembers(Integer selectionId, Integer[] ids)

NSSelectionAgent agent;
Integer selectionId;
Integer[] ids;
Integer res = agent.AddSelectionMembers(selectionId, ids);

Parameters

Returns

AddSelectionMembersFromSearch(Integer,String)

Adds members from the selection using the search result.

Declaration

Integer AddSelectionMembersFromSearch(Integer selectionId, String storageKey)

NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.AddSelectionMembersFromSearch(selectionId, storageKey);

Parameters

Returns

CopyContactSelectionMembers(Integer,Integer)

Copies contact selection members from selection into an existing selection.

Declaration

Void CopyContactSelectionMembers(Integer fromSelectionId, Integer toSelectionId)

Parameters

Returns

CopySelectionMembers(Integer,Integer)

Copies selection members from selection into an existing selection.

Declaration

Void CopySelectionMembers(Integer fromSelectionId, Integer toSelectionId)

Parameters

Returns

CreateContactSelectionFromSelection(Integer,String,Integer,Bool)

Creates a new selection based on selection members from an existing selection.

Declaration

NSSelectionEntity CreateContactSelectionFromSelection(Integer selectionId, String name, Integer targetSelectionType, Bool copyMembers)

NSSelectionAgent agent;
Integer selectionId;
String name;
Integer targetSelectionType;
Bool copyMembers;
NSSelectionEntity res = agent.CreateContactSelectionFromSelection(selectionId, name, targetSelectionType, copyMembers);

Parameters

Returns

CreateContactSelectionFromShadowSelection(Integer,String)

Creates a new contact selection based on contact selection members from an existing shadow sale, appointment, project or document selection.

Declaration

NSSelectionEntity CreateContactSelectionFromShadowSelection(Integer selectionId, String name)

NSSelectionAgent agent;
Integer selectionId;
String name;
NSSelectionEntity res = agent.CreateContactSelectionFromShadowSelection(selectionId, name);

Parameters

Returns

CreateDefaultMailMergeSettings()

Sets default values into a new NSMailMergeSettings.

Declaration

NSMailMergeSettings CreateDefaultMailMergeSettings()

NSSelectionAgent agent;
NSMailMergeSettings thing = agent.CreateDefaultMailMergeSettings();
thing = agent.SaveMailMergeSettings(thing);

Returns

CreateDefaultMailMergeTask()

Sets default values into a new NSMailMergeTask.

Declaration

NSMailMergeTask CreateDefaultMailMergeTask()

NSSelectionAgent agent;
NSMailMergeTask thing = agent.CreateDefaultMailMergeTask();
thing = agent.SaveMailMergeTask(thing);

Returns

CreateDefaultSelectionEntity()

Sets default values into a new NSSelectionEntity.

Declaration

NSSelectionEntity CreateDefaultSelectionEntity()

NSSelectionAgent agent;
NSSelectionEntity thing = agent.CreateDefaultSelectionEntity();
thing = agent.SaveSelectionEntity(thing);

Returns

CreateNewEntry(NSDuplicateEntry)

Creates a new selection based on external duplicate

Declaration

Integer CreateNewEntry(NSDuplicateEntry duplicate)

NSSelectionAgent agent;
NSDuplicateEntry duplicate;
Integer res = agent.CreateNewEntry(duplicate);

Parameters

Returns

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()

Declaration

NSSelectionEntity CreateSelectionEntity(String targetTableName)

NSSelectionAgent agent;
String targetTableName;
NSSelectionEntity res = agent.CreateSelectionEntity(targetTableName);

Parameters

Returns

CreateSelectionFromSelection(Integer,String,Integer,Bool)

Creates a new selection based on selection members from an existing selection.

Declaration

NSSelectionEntity CreateSelectionFromSelection(Integer selectionId, String name, Integer targetSelectionType, Bool copyMembers)

NSSelectionAgent agent;
Integer selectionId;
String name;
Integer targetSelectionType;
Bool copyMembers;
NSSelectionEntity res = agent.CreateSelectionFromSelection(selectionId, name, targetSelectionType, copyMembers);

Parameters

Returns

CreateTemporaryContactSelection()

Creates a temporary selection.

Declaration

NSSelectionEntity CreateTemporaryContactSelection()

NSSelectionAgent agent;
NSSelectionEntity res = agent.CreateTemporaryContactSelection();

Returns

CreateTemporaryContactSelectionFromContactPersonIds(NSContactPersonId[])

Creates a temporary selection with members from a collection of ContactPerson IDs.

Declaration

NSSelectionEntity CreateTemporaryContactSelectionFromContactPersonIds(NSContactPersonId[] contactPersonIds)

NSSelectionAgent agent;
NSContactPersonId[] contactPersonIds;
NSSelectionEntity res = agent.CreateTemporaryContactSelectionFromContactPersonIds(contactPersonIds);

Parameters

Returns

CreateTemporaryContactSelectionFromProjectMembers(Integer)

Creates a temporary selection with members from an existing project.

Declaration

NSSelectionEntity CreateTemporaryContactSelectionFromProjectMembers(Integer projectId)

NSSelectionAgent agent;
Integer projectId;
NSSelectionEntity res = agent.CreateTemporaryContactSelectionFromProjectMembers(projectId);

Parameters

Returns

CreateTemporaryContactSelectionFromSelectionMemberIds(Integer,Integer[])

Creates a temporary selection with members from a collection of selection-member IDs.

Declaration

NSSelectionEntity CreateTemporaryContactSelectionFromSelectionMemberIds(Integer selectionId, Integer[] selectionMemberIds)

NSSelectionAgent agent;
Integer selectionId;
Integer[] selectionMemberIds;
NSSelectionEntity res = agent.CreateTemporaryContactSelectionFromSelectionMemberIds(selectionId, selectionMemberIds);

Parameters

Returns

CreateTemporarySelectionFromIds(Integer[],Integer)

Creates a temporary selection with members from a collection of entity IDs.

Declaration

NSSelectionEntity CreateTemporarySelectionFromIds(Integer[] ids, Integer targetTableNumber)

NSSelectionAgent agent;
Integer[] ids;
Integer targetTableNumber;
NSSelectionEntity res = agent.CreateTemporarySelectionFromIds(ids, targetTableNumber);

Parameters

Returns

DeleteContacts(Integer)

Deletes all contacts from a selection.

Declaration

Void DeleteContacts(Integer selectionId)

Parameters

Returns

DeleteEntities(Integer)

Deletes all entities from a selection.

Declaration

Void DeleteEntities(Integer selectionId)

Parameters

Returns

DeletePersons(Integer)

Deletes all persons from a selection.

Declaration

Void DeletePersons(Integer selectionId)

Parameters

Returns

DeleteSelectionEntity(Integer)

Deletes the NSSelectionEntity

Declaration

DeleteSelectionEntity(Integer selectionEntity)

NSSelectionAgent agent;
agent.DeleteSelectionEntity(123);

Parameters

Returns

EditContactSelectionMemberDetails(Integer,NSSelectionMemberEditValues)

Edits company and contact details in a selection based on contents in selectionMemberEditValues.

Declaration

Void EditContactSelectionMemberDetails(Integer selectionId, NSSelectionMemberEditValues selectionMemberEditValues)

Parameters

Returns

ExportSelectionMembers(Integer,String,Bool)

Generates a string that is the result of substituting the template variables with values from selection members.

Declaration

Byte[] ExportSelectionMembers(Integer selectionId, String templateName, Bool useContacts)

NSSelectionAgent agent;
Integer selectionId;
String templateName;
Bool useContacts;
Byte[] res = agent.ExportSelectionMembers(selectionId, templateName, useContacts);

Parameters

Returns

ExportSelectionMembersWithOrderBy(Integer,String,Bool,String)

Generates a string that is the result of substituting the template variables with values from selection members.

Declaration

Byte[] ExportSelectionMembersWithOrderBy(Integer selectionId, String templateName, Bool useContacts, String orderBy)

NSSelectionAgent agent;
Integer selectionId;
String templateName;
Bool useContacts;
String orderBy;
Byte[] res = agent.ExportSelectionMembersWithOrderBy(selectionId, templateName, useContacts, orderBy);

Parameters

Returns

GenerateFollowUps(Integer,NSAppointmentEntity,Integer,Bool,Bool)

Generates follow-ups for members in the selection.

Declaration

Void GenerateFollowUps(Integer selectionId, NSAppointmentEntity appointmentEntity, Integer associateId, Bool saveOnContactOwner, Bool uniqueContact)

Parameters

Returns

GetDuplicateRules()

Retrieves all available duplicate rules for selection

Declaration

NSDuplicateRule[] GetDuplicateRules()

NSSelectionAgent agent;
NSDuplicateRule[] res = agent.GetDuplicateRules();

Returns

GetDuplicates(String)

Gets duplicates(exact or similar in the database) based on the name

Declaration

NSDuplicateEntry[] GetDuplicates(String name)

NSSelectionAgent agent;
String name;
NSDuplicateEntry[] res = agent.GetDuplicates(name);

Parameters

Returns

GetDynamicSelectionCriteria(Integer)

Gets the criteria for this dynamic selection.

Declaration

NSArchiveRestrictionInfo[] GetDynamicSelectionCriteria(Integer selectionId)

NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionInfo[] res = agent.GetDynamicSelectionCriteria(selectionId);

Parameters

Returns

GetDynamicSelectionCriteriaGroups(Integer)

Gets the criteria for this dynamic selection. This call supports multiple criteria groups.

Declaration

NSArchiveRestrictionGroup[] GetDynamicSelectionCriteriaGroups(Integer selectionId)

NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionGroup[] res = agent.GetDynamicSelectionCriteriaGroups(selectionId);

Parameters

Returns

GetParentCombinedSelections(Integer)

Gets a list of all selection ids where the given selection is used to create a combined selection.

Declaration

Integer[] GetParentCombinedSelections(Integer selectionId)

NSSelectionAgent agent;
Integer selectionId;
Integer[] res = agent.GetParentCombinedSelections(selectionId);

Parameters

Returns

GetRecipientStatistics(Integer)

Returns an NSRecipientStatistics object with a count of addresses and email addresses.

Declaration

NSRecipientStatistics GetRecipientStatistics(Integer selectionId)

NSSelectionAgent agent;
Integer selectionId;
NSRecipientStatistics res = agent.GetRecipientStatistics(selectionId);

Parameters

Returns

GetRecipientStatisticsFromContactPersonIds()

Returns an NSRecipientStatistics object with a count of addresses and email addresses based on contact and persons in a collection of ContactPersonId.

Declaration

NSRecipientStatistics GetRecipientStatisticsFromContactPersonIds(NSContactPersonId[] contactPersonIds)

NSSelectionAgent agent;
NSContactPersonId[] contactPersonIds;
NSRecipientStatistics res = agent.GetRecipientStatisticsFromContactPersonIds(contactPersonIds);

Returns

GetRecipientStatisticsFromProjectMembers(Integer)

Returns an NSRecipientStatistics object with a count of addresses and email addresses based on members in a project.

Declaration

NSRecipientStatistics GetRecipientStatisticsFromProjectMembers(Integer projectId)

NSSelectionAgent agent;
Integer projectId;
NSRecipientStatistics res = agent.GetRecipientStatisticsFromProjectMembers(projectId);

Parameters

Returns

GetSelectionEntity(Integer)

Gets an NSSelectionEntity object.

Declaration

NSSelectionEntity GetSelectionEntity(Integer selectionEntityId)

NSSelectionAgent agent;
NSSelectionEntity thing = agent.GetSelectionEntity(123);

Parameters

Returns

GetSelectionForFind(String,Integer)

Obtains a selection for the given entity, for the current user, of type WorkingSetForFind.

Declaration

NSSelectionForFind GetSelectionForFind(String entityName, Integer typicalSearchId)

NSSelectionAgent agent;
String entityName;
Integer typicalSearchId;
NSSelectionForFind res = agent.GetSelectionForFind(entityName, typicalSearchId);

Parameters

Returns

GetSelectionMembersArchiveRows(Integer,String)

Gets the list of members in this selection. The type of members depends on the target table of the selection.

Declaration

NSArchiveListItem[] GetSelectionMembersArchiveRows(Integer selectionId, String select)

NSSelectionAgent agent;
Integer selectionId;
String select;
NSArchiveListItem[] res = agent.GetSelectionMembersArchiveRows(selectionId, select);

Parameters

Returns

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

Declaration

NSArchiveListItem[] GetSelectionShadowMembersArchiveRows(Integer selectionId, String select)

NSSelectionAgent agent;
Integer selectionId;
String select;
NSArchiveListItem[] res = agent.GetSelectionShadowMembersArchiveRows(selectionId, select);

Parameters

Returns

RemoveContactSelectionMembers(Integer,NSContactPersonId[])

Removes members from the selection as specified in the collection of ContactPersonId.

Declaration

Void RemoveContactSelectionMembers(Integer selectionId, NSContactPersonId[] contactPersonIds)

Parameters

Returns

RemoveContactSelectionMembersFromIds(Integer,Integer[])

Removes members from the selection using a collection a selection-member IDs.

Declaration

Void RemoveContactSelectionMembersFromIds(Integer selectionId, Integer[] selectionMembersIds)

Parameters

Returns

RemoveContactSelectionMembersFromSearch(Integer,String)

Removes members from the selection using the search result.

Declaration

Integer RemoveContactSelectionMembersFromSearch(Integer selectionId, String storageKey)

NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.RemoveContactSelectionMembersFromSearch(selectionId, storageKey);

Parameters

Returns

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)

Declaration

Void RemoveSelectionMembers(Integer selectionId, Integer[] selectionMemberIds)

Parameters

Returns

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.

Declaration

Void RemoveSelectionMembersById(Integer selectionId, Integer[] ids)

Parameters

Returns

RemoveSelectionMembersFromSearch(Integer,String)

Removes members from the selection using the search result.

Declaration

Integer RemoveSelectionMembersFromSearch(Integer selectionId, String storageKey)

NSSelectionAgent agent;
Integer selectionId;
String storageKey;
Integer res = agent.RemoveSelectionMembersFromSearch(selectionId, storageKey);

Parameters

Returns

SaveSelectionEntity(NSSelectionEntity)

Updates the existing NSSelectionEntity or creates a new NSSelectionEntity if the ID parameter is 0.

Declaration

NSSelectionEntity SaveSelectionEntity(NSSelectionEntity selectionEntity)

NSSelection agent;
NSSelectionEntity thing = agent.CreateDefaultSelectionEntity();
thing = agent.SaveSelectionEntity(thing);

Parameters

Returns

SetDuplicateRulesStatus(NSDuplicateRule[])

Sets which duplicate rules should be active or not

Declaration

Void SetDuplicateRulesStatus(NSDuplicateRule[] rules)

Parameters

Returns

SetDynamicSelectionCriteria(Integer,NSArchiveRestrictionInfo[])

Updates the criteria for this dynamic selection. Replaces existing criteria with the new values.

Declaration

NSArchiveRestrictionInfo[] SetDynamicSelectionCriteria(Integer selectionId, NSArchiveRestrictionInfo[] criteria)

NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionInfo[] criteria;
NSArchiveRestrictionInfo[] res = agent.SetDynamicSelectionCriteria(selectionId, criteria);

Parameters

Returns

SetDynamicSelectionCriteria2(Integer,String)

Updates the criteria for this dynamic selection using string.

Declaration

NSArchiveRestrictionInfo[] SetDynamicSelectionCriteria2(Integer selectionId, String filter)

NSSelectionAgent agent;
Integer selectionId;
String filter;
NSArchiveRestrictionInfo[] res = agent.SetDynamicSelectionCriteria2(selectionId, filter);

Parameters

Returns

SetDynamicSelectionCriteria3(Integer,NSArchiveRestrictionInfo[],String)

Updates the criteria for this dynamic selection. Use criteria as either restriction objects or OData string format.

Declaration

NSArchiveRestrictionInfo[] SetDynamicSelectionCriteria3(Integer selectionId, NSArchiveRestrictionInfo[] criteria, String filter)

NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionInfo[] criteria;
String filter;
NSArchiveRestrictionInfo[] res = agent.SetDynamicSelectionCriteria3(selectionId, criteria, filter);

Parameters

Returns

SetDynamicSelectionCriteriaGroups(Integer,NSArchiveRestrictionGroup[])

Updates the criteria for this dynamic selection. Replaces existing criteria with the new values. This call supports multiple criteria groups.

Declaration

NSArchiveRestrictionGroup[] SetDynamicSelectionCriteriaGroups(Integer selectionId, NSArchiveRestrictionGroup[] criteria)

NSSelectionAgent agent;
Integer selectionId;
NSArchiveRestrictionGroup[] criteria;
NSArchiveRestrictionGroup[] res = agent.SetDynamicSelectionCriteriaGroups(selectionId, criteria);

Parameters

Returns

StartMailMerge(MailMergeSettings)

Starts a mail-merge operation with specified settings.

Declaration

Void StartMailMerge(MailMergeSettings settings)

Parameters

Returns

UpdateTypicalSearch(NSTypicalSearches)

Updates (imports) TypicalSearch information in the database

Declaration

String UpdateTypicalSearch(NSTypicalSearches searches)

NSSelectionAgent agent;
NSTypicalSearches searches;
String res = agent.UpdateTypicalSearch(searches);

Parameters

Returns