Constructors
NSListAgent()
Methods
AddFromListDefinition(Integer,NSListItemEntity)
Saves a new list item for the specified list definitionAddFromListName(String,NSListItemEntity)
Saves a new list item for the specified list definitionAddHierarchyToPath(Integer,String,String)
Adds a hierarchy item to a pathChangeCurrency(Float,String,String)
Recalculates the amount to the new currency.CreateDefaultAmountClassEntity()
Sets default values into a new NSAmountClassEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultCountry()
Gets a new countryCreateDefaultCurrencyEntity()
Sets default values into a new NSCurrencyEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultDocumentTemplateEntity()
Sets default values into a new NSDocumentTemplateEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultDocumentTemplateLanguage(Integer,String)
Creates a new document template language based on an existing templateCreateDefaultExtAppEntity()
Sets default values into a new NSExtAppEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultHeadingEntity()
Sets default values into a new NSHeadingEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultHeadingFromListDefinition(Integer)
Gets a heading for the specified list definitionCreateDefaultHierarchyEntity()
Sets default values into a new NSHierarchyEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultListEntity()
Sets default values into a new NSListEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultListItemEntity()
Sets default values into a new NSListItemEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultProjectTypeEntity()
Sets default values into a new NSProjectTypeEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultRelationDefinitionEntity()
Sets default values into a new NSRelationDefinitionEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultResourceEntity()
Sets default values into a new NSResourceEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultSaleStageEntity()
Sets default values into a new NSSaleStageEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultSaleTypeEntity()
Sets default values into a new NSSaleTypeEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultTicketCategoryEntity()
Sets default values into a new NSTicketCategoryEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultTicketPriorityEntity()
Sets default values into a new NSTicketPriorityEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultTicketStatusEntity()
Sets default values into a new NSTicketStatusEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultWebPanelEntity()
Sets default values into a new NSWebPanelEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
DeleteAllFromListDefinition(Integer)
Marks all items in the list deletedDeleteAllFromListName(String)
Marks all items in the list deletedDeleteAllHeadingsFromListDefinition(Integer)
Deletes all headings for list resolved by the provided ID.DeleteAllHeadingsFromName(String)
Deletes all headings for list resolved by the provided name.DeleteAppWebPanels()
Permanently delete all web panels owned by your app.Works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happens
DeleteDocumentTemplateLanguage(Integer,String)
Deletes language variant of the document templateDeleteFromListDefinition(Integer,Integer)
Deletes a list item from the specified list definitionDeleteFromListName(Integer,String)
Deletes a list item from the specified list definitionDeleteHierarchyEntity(Integer)
Deletes the NSHierarchyEntityDeleteHierarchyFromPath(Integer,String)
Removes a hierarchy item and its children from a pathDeleteListEntity(Integer)
Deletes the NSListEntityDeleteListEntityByName(String)
Deletes an NSListEntity resolved by the provided name.DeleteProjectStatus(Integer)
Deletes a project statusDeleteResourceEntity(Integer)
Deletes the NSResourceEntityDeleteTicketCategoryEntity(Integer)
Deletes the NSTicketCategoryEntityDeleteTicketPriorityEntity(Integer)
Deletes the NSTicketPriorityEntityDeleteTicketStatusEntity(Integer)
Deletes the NSTicketStatusEntityDeleteWebPanel(Integer)
Hard-delete (real, permanent DELETE in the database) the given web panel. Use with care!GenerateNavigationUrl(Integer,String)
Generates the navigation URL to be used to navigate to the panelGetAllCountries(Bool)
Returns all available countries a contact or person could belong to.GetAllCurrencies(Bool)
Returns all currenciesGetAllDocumentTemplates(Bool)
Returns all templatesGetAllDomains()
Gets list of all domainsGetAllFromListDefinition(Integer,Bool)
Gets all list items for the specified list definitionGetAllFromListName(String,Bool)
Gets all list items for the specified list definitionGetAllInDomain(Integer,Bool)
Gets all items in a domainGetAllSaleStages(Bool)
Returns all ratingsGetAllSaleType()
Returns all sale types as simple list itemsGetAllSaleTypeEntities(Bool)
Returns all sale types as entities with stakeholders, guide and quote propertiesGetAllTasks(Bool)
Returns all appointment tasksGetAllTicketPriorities(Bool)
Returns all available ticket priorities.GetAmountClassEntity(Integer)
Gets an NSAmountClassEntity object.GetAppWebPanels()
Gets all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationTokenGetBaseCurrency()
Gets the base currency, used for calculating exchange ratesGetBusiness(Integer)
Gets an NSBusiness object.GetBusinesses()
Returns all available businesses that a contact could have.GetBusinessList(Integer[])
Gets an array of NSBusiness objects.GetCategories()
Returns all categories a contact could belong toGetCategory(Integer)
Gets an NSCategory object.GetCategoryList(Integer[])
Gets an array of NSCategory objects.GetCompetitor(Integer)
Gets an NSCompetitor object.GetCompetitorList(Integer[])
Gets an array of NSCompetitor objects.GetCompetitors()
Returns all competitorsGetConsentPurpose(Integer)
Gets an NSConsentPurpose object.GetConsentPurposeList(Integer[])
Gets an array of NSConsentPurpose objects.GetConsentPurposes()
Returns all defined purposes.GetConsentSource(Integer)
Gets an NSConsentSource object.GetConsentSourceList(Integer[])
Gets an array of NSConsentSource objects.GetConsentSources()
Returns all defined Sources.GetCountries()
Returns all available countries a contact or person could belong to.GetCountry(Integer)
Gets an NSCountry object.GetCountryList(Integer[])
Gets an array of NSCountry objects.GetCredited(Integer)
Gets an NSCredited object.GetCreditedList(Integer[])
Gets an array of NSCredited objects.GetCrediteds()
Returns all creditedGetCurrencies()
Returns all currenciesGetCurrency(Integer)
Gets an NSCurrency object.GetCurrencyEntity(Integer)
Gets an NSCurrencyEntity object.GetCurrencyList(Integer[])
Gets an array of NSCurrency objects.GetCustomerLanguage(Integer)
Gets an NSCustomerLanguage object.GetCustomerLanguageList(Integer[])
Gets an array of NSCustomerLanguage objects.GetCustomerLanguages()
GetDeliveryTerm(Integer)
Gets an NSDeliveryTerm object.GetDeliveryTerms()
Returns all DeliveryTerms in SuperOffice database.GetDeliveryType(Integer)
Gets an NSDeliveryType object.GetDeliveryTypes()
Returns all DeliveryTypes in SuperOffice database.GetDepartment(Integer)
Gets an NSDepartment object.GetDepartmentList(Integer[])
Gets an array of Department objects.GetDepartments()
Gets all departments/user groups for the internal phone list with the user’s colleagues.GetDocumentTemplate(Integer)
Gets an NSDocumentTemplate object.GetDocumentTemplateEntity(Integer)
Gets an NSDocumentTemplateEntity object.GetDocumentTemplateExtension(Integer)
Gets the file extension for the document templateGetDocumentTemplateLanguages(Integer)
Gets the supported language variations for a document templateGetDocumentTemplateList(Integer[])
Gets an array of NSDocumentTemplate objects.GetDocumentTemplateProperties(Integer,String[])
Retrieves a list of key-value pairs of document template propertiesGets document template properties.. <code>Map GetDocumentTemplateProperties(Integer documentTemplateId, String[] requestedProperties)</code>GetDocumentTemplates()
Returns all available document templatesGetDocumentTemplatesTasks()
The appointment’s task is a Document template item when the appointment is a document.GetDocumentTemplateStreamFromId(Integer,String)
Retrieves a stream to a document template based on its IDGetDocumentTemplateTask(Integer)
Returns a Document Template list item as a TaskListItem.The appointment’s task is a Document template item when the appointment is a document.
GetDocumentTemplateUrl(Integer,Bool,String)
Gets a url to the document templateGetDocumentTemplateUsedInProjectStage(Integer)
Gets a String array of names in project guide that this template is used inGetDocumentTemplateUsedInSalesStage(Integer)
Gets a String array of names in sales guide that this template is used inGetDocumentTypesForPlugin(Integer)
Gets a list of document types supported by a given document plugin. Use the document template type when creating a new template.GetEmarketingStrictMode()
Gets the value of the Emarketing strict mode settingGetExtAppEntity(Integer)
Gets an NSExtAppEntity object.GetFromListDefinition(Integer,Integer)
Gets a list item for the specified list definitionGetFromListName(Integer,String)
Gets a list item for the specified list definitionGetHeadingEntity(Integer)
Gets an NSHeadingEntity object.GetHeadings(Integer,Integer,Bool)
Gets a selectable MDO list of the headings for this list itemGetHeadingsForListItemFromListName(String,Integer,Bool)
Gets a selectable MDO list of the headings for this list itemGetHeadingsFromListDefinition(Integer)
Gets headings for list resolved by the provided ID.GetHeadingsFromName(String)
Gets headings for list resolved by the provided name.GetHierarchyEntity(Integer)
Gets an NSHierarchyEntity object.GetHierarchyFromPath(Integer,String,Bool)
Gets a hierarchy item from a pathGetInstalledLanguages()
Returns the list of all languages installed in this database.GetLanguageInfo(Integer)
Gets an NSLanguageInfo object.GetLanguageInfoList(Integer[])
Gets an array of NSLanguageInfo objects.GetLegalBase(Integer)
Gets an NSLegalBase object.GetLegalBaseList(Integer[])
Gets an array of NSLegalBase objects.GetLegalBases()
Returns all defined bases.GetLink(Integer)
Gets an NSLink object.GetLinkList(Integer[])
Gets an array of Link objects.GetListDefinitions(Bool)
Gets a list of the lists, built-in and user-defined.GetListEntity(Integer)
Gets an NSListEntity object.GetListEntityByName(String)
Gets an NSListEntity resolved by the provided name.GetListItemsForHeading(Integer,Integer)
GetListItemsForHeadingFromListName(String,Integer)
GetListItemsForUserGroup(Integer,Integer)
GetListItemsForUserGroupFromListName(String,Integer)
GetLocalizedText(Integer)
Gets an NSLocalizedText object.GetLocalizedTextByType(Integer,Integer,Integer)
Returns a localized text based on the resource ID for the selected language.GetLocalizedTextList(Integer[])
Gets an array of NSLocalizedText objects.GetLocalizedTexts()
Gets all localized texts in the CRM database.GetLocalizedTextsByLanguageId(Integer)
Gets all localized text belonging to a specific language.GetLocalizedTextsByType(Integer[])
Gets localized text by their typeGets localized text by their type.GetMrMrs(Integer)
Gets an NSMrMrs object.GetMrMrses()
Returns all Items from the NSMrMrs table sorted by their value.GetMrMrsList(Integer[])
Gets an array of NSMrMrs objects.GetOurCurrency()
Gets the Our currency object if currency is enabledGetOwnerCompanysCurrency()
Gets the currency of the user’s owner companyGetPaymentTerm(Integer)
Gets an NSPaymentTerm object.GetPaymentTerms()
Returns all PaymentTerms in SuperOffice database.GetPaymentType(Integer)
Gets an NSPaymentType object.GetPaymentTypes()
Returns all PaymentTypes in SuperOffice database.GetPluginCapabilities(Integer)
Gets a list of plugin-dependent capabilities for a given document archive plugin.A standard set of properties is defined in SuperOffice.CRM.Documents.Constants.Capabilities.
GetPluginList()
Gets a list of installed document pluginsGetPosition(Integer)
Gets an NSPosition object.GetPositionList(Integer[])
Gets an array of NSPosition objects.GetPositions()
Returns all the positions a person could have.GetPriorities()
Returns all priorities an appointment could have.GetPriority(Integer)
Gets an NSPriority object.GetPriorityList(Integer[])
Gets an array of Priority objects.GetProductCategories()
Returns all ProductCategories in SuperOffice list.GetProductCategory(Integer)
Gets an NSProductCategory object.GetProductFamilies()
Returns all NSProductFamily in SuperOffice list.GetProductFamily(Integer)
Gets an NSProductFamily object.GetProductType(Integer)
Gets an NSProductType object.GetProductTypes()
Returns all ProductTypes in SuperOffice list.GetProjectStatus(Integer)
Gets an NSProjectStatus object.GetProjectStatuses()
Gets all items from the Project Status (ProjStatus) table.GetProjectStatusList(Integer[])
Gets an array of NSProjectStatus objects.GetProjectType(Integer)
Gets an NSProjectType object.GetProjectTypeEntity(Integer)
Gets an NSProjectTypeEntity object.GetProjectTypeList(Integer[])
Gets an array of NSProjectType objects.GetProjectTypes()
Gets all items from the Project Type (ProjType) table.GetQuickReplies()
Method to return all quick replies for a given associateGetRating(Integer)
Gets an NSRating object.GetRatingList(Integer[])
Gets an array of NSRating objects.GetRatings()
Returns all ratingsGetReason(Integer)
Gets an NSReason object.GetReasonList(Integer[])
Gets an array of NSReason objects.GetReasons()
Returns all reasonsGetReasonSold(Integer)
Gets an NSReasonSold object.GetReasonSoldList(Integer[])
Gets an array of ReasonSold objects.GetReasonStalled(Integer)
Gets an NSReasonStalled object.GetReasonStalledList(Integer[])
Gets an array of ReasonStalled objects.GetRelationDefinitionEntity(Integer)
Gets an NSRelationDefinitionEntity object.GetResourceEntity(Integer)
Gets an NSResourceEntity object.GetSaleStageEntity(Integer)
Gets an NSSaleStageEntity object.GetSaleType(Integer)
Gets an NSSaleType object.GetSaleTypeEntity(Integer)
Gets an NSSaleTypeEntity object.GetSaleTypeList(Integer[])
Gets an array of NSSaleType objects.GetSelectionCategory(Integer)
Gets an NSSelectionCategory object.GetSelectionCategoryList(Integer[])
Gets an array of SelectionCategory objects.GetSource(Integer)
Gets an NSSource object.GetSourceList(Integer[])
Gets an array of Source objects.GetSources()
Returns all sourcesGetTask(Integer)
Gets an NSTask object.GetTaskList(Integer[])
Gets an array of Task objects.GetTasks()
Returns all appointment tasksGetTicketCategories()
GetTicketCategoriesForUserGroups(Integer[])
GetTicketCategory(Integer)
Gets an NSTicketCategory object.GetTicketCategoryEntity(Integer)
Gets an NSTicketCategoryEntity object.GetTicketCategoryList(Integer[])
Gets an array of NSTicketCategoryEntity objects.GetTicketPriorities()
GetTicketPriority(Integer)
Gets an NSTicketPriority object.GetTicketPriorityEntity(Integer)
Gets an NSTicketPriorityEntity object.GetTicketPriorityList(Integer[])
Gets an array of NSTicketPriority objects.GetTicketStatusEntity(Integer)
Gets an NSTicketStatusEntity object.GetTicketStatuses()
GetTicketStatusList(Integer[])
Gets an array of NSTicketStatusEntity objects.GetVisibleForUserGroups(Integer,Integer)
GetVisibleForUserGroupsFromListName(String,Integer)
GetWebPanelByProgId(String)
Gets a web panel using the ProgId key that was specified when it was createdGetWebPanelEntity(Integer)
Gets an NSWebPanelEntity object.GetWebPanelList()
Return a list of all web panels.GlobalChangeTicketStatus(Integer,Integer)
Changes all references from one ticket status to another.Typically used in conjunction with delete.
MoveAllTickets(Integer,Integer)
Moves all tickets from one ticket category to anotherMoveListItem(Integer,Integer,Integer)
Moves a list item up or down in the list based on rankRebuildFullnames()
Updates the fullname field of all categoriesUse this for example when changing parentId or renaming a category with children.
SaveAllFromListDefinition(Integer,NSListItemEntity[])
Saves all list items for the specified list definitionSaveAllFromListName(String,NSListItemEntity[])
Saves all list items for the specified list definitionSaveAmountClassEntity(NSAmountClassEntity)
Updates the existing NSAmountClassEntity or creates a new NSAmountClassEntity if the id parameter is 0SaveConsentPurpose(NSConsentPurpose)
Saves an NSConsentPurpose objectSaveConsentSource(NSConsentSource)
SaveCountry(NSCountry)
Saves a countrySaveCurrencyEntity(NSCurrencyEntity)
Updates the existing NSCurrencyEntity or creates a new NSCurrencyEntity if the id parameter is 0SaveDocumentTemplateEntity(NSDocumentTemplateEntity)
Updates the existing NSDocumentTemplateEntity or creates a new NSDocumentTemplateEntity if the id parameter is 0SaveDocumentTemplateStream(Integer,NSStream,String,Integer)
Writes content in stream to document template fileSaveExtAppEntity(NSExtAppEntity)
Updates the existing NSExtAppEntity or creates a new NSExtAppEntity if the id parameter is 0SaveFromListDefinition(Integer,Integer,NSListItemEntity)
Saves a list item for the specified list definitionSaveFromListName(Integer,String,NSListItemEntity)
Saves a list item for the specified list definitionSaveHeadingEntity(NSHeadingEntity)
Updates the existing NSHeadingEntity or creates a new NSHeadingEntity if the id parameter is 0SaveHeadingFromListDefinition(Integer,NSHeadingEntity)
Saves new heading for list resolved by the provided ID.SaveHeadingFromName(String,NSHeadingEntity)
Saves new heading for list resolved by the provided name.SaveHeadingsForListItemFromListDefinition(Integer,Integer,NSSelectableMDOListItem[])
Saves the active headings for the list item.SaveHeadingsForListItemFromListName(String,Integer)
Saves the headings for the list item.SaveHeadingsFromListDefinition(Integer)
Save headings for list resolved by the provided id.SaveHeadingsFromName(String)
Saves headings for list resolved by the provided name.SaveHierarchyEntity(NSHierarchyEntity)
Updates the existing NSHierarchyEntity or creates a new NSHierarchyEntity if the id parameter is 0SaveLegalBase(NSLegalBase)
SaveListEntity(NSListEntity)
Updates the existing NSListEntity or creates a new NSListEntity if the id parameter is 0SaveListEntityByName(String,NSListEntity)
Saves an NSListEntity resolved by the provided name.SaveListItemEntity(NSListItemEntity)
Saves the NSListItemEntity.SaveProjectTypeEntity(NSProjectTypeEntity)
Updates the existing NSProjectTypeEntity or creates a new NSProjectTypeEntity if the id parameter is 0SaveQuickReplies(NSQuickReply[])
Saves all quick replies for a given associateSaveRelationDefinitionEntity(NSRelationDefinitionEntity)
Updates the existing NSRelationDefinitionEntity or creates a new NSRelationDefinitionEntity if the id parameter is 0SaveResourceEntity(NSResourceEntity)
Updates the existing NSResourceEntity or creates a new NSResourceEntity if the id parameter is 0SaveSaleStageEntity(NSSaleStageEntity)
Updates the existing NSSaleStageEntity or creates a new NSSaleStageEntity if the id parameter isSaveSaleTypeEntity(NSSaleTypeEntity)
Updates the existing NSSaleTypeEntity or creates a new NSSaleTypeEntity if the id parameter is 0SaveTicketCategoryEntity(NSTicketCategoryEntity)
Updates the existing NSTicketCategoryEntity or creates a new NSTicketCategoryEntity if the id parameter is 0SaveTicketPriorityEntity(NSTicketPriorityEntity)
Updates the existing NSTicketPriorityEntity or creates a new NSTicketPriorityEntity if the id parameter is 0SaveTicketStatusEntity(NSTicketStatusEntity)
Updates the existing NSTicketStatusEntity or creates a new NSTicketStatusEntity if the id parameter is 0SaveWebPanelEntity(NSWebPanelEntity)
Updates the existing NSWebPanelEntity or creates a new NSWebPanelEntity if the id parameter is 0SetDocumentTemplateFromDocumentTemplate(Integer,NSDocumentTemplateEntity)
Creates a new document template based on another templateSetDocumentTemplateStream(NSDocumentTemplateEntity,NSStream,String,Integer)
Stores a document template from its stream.Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.