Class NSContactEntity

The Contact Service. Implements all services working with the Contact object.

Constructors

NSContactEntity()

Initializes a new instance of the NSContactEntity class.

Declaration

NSContactEntity

Methods

GetActiveErpLinks()

Declaration

Integer GetActiveErpLinks()

Examples

NSContactEntity thing;
Integer activeErpLinks = thing.GetActiveErpLinks();

Returns

Type Description
Integer The number of active ERP links.

GetActiveInterests()

Declaration

Integer GetActiveInterests()

Examples

NSContactEntity thing;
Integer activeInterests = thing.GetActiveInterests();

Returns

Type Description
Integer The number of active interests.

GetActiveStatusMonitorId()

Declaration

Integer GetActiveStatusMonitorId()

Examples

NSContactEntity thing;
Integer activeStatusMonitorId = thing.GetActiveStatusMonitorId();

Returns

Type Description
Integer Active status monitor identity with the lowest rank for contact.

GetAddress()

Declaration

NSAddress GetAddress()

Examples

NSContactEntity thing;
NSAddress address = thing.GetAddress();

Returns

Type Description
NSAddress

GetAssociate()

Declaration

NSAssociate GetAssociate()

Examples

NSContactEntity thing;
NSAssociate associate = thing.GetAssociate();

Returns

Type Description
NSAssociate The user that owns this contact.

GetBounceEmails()

Declaration

String[] GetBounceEmails()

Examples

NSContactEntity thing;
String[] bounceEmails = thing.GetBounceEmails();

Returns

Type Description
String[] Email addresses with a positive bounce counter.

GetBusiness()

Declaration

NSBusiness GetBusiness()

Examples

NSContactEntity thing;
NSBusiness business = thing.GetBusiness();

Returns

Type Description
NSBusiness The business that the contact is associated with.

GetCategory()

Declaration

NSCategory GetCategory()

Examples

NSContactEntity thing;
NSCategory category = thing.GetCategory();

Returns

Type Description
NSCategory The category that is set on the company.

GetContactId()

Declaration

Integer GetContactId()

Examples

NSContactEntity thing;
Integer contactId = thing.GetContactId();

Returns

Type Description
Integer Primary key.

GetCountry()

Declaration

NSCountry GetCountry()

Examples

NSContactEntity thing;
NSCountry country = thing.GetCountry();

Returns

Type Description
NSCountry The country this contact is located in.

GetCreatedBy()

Declaration

NSAssociate GetCreatedBy()

Examples

NSContactEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

Returns

Type Description
NSAssociate The user that created the contact.

GetCreatedDate()

Declaration

DateTime GetCreatedDate()

Examples

NSContactEntity thing;
DateTime createdDate = thing.GetCreatedDate();

Returns

Type Description
DateTime Date registered.

GetCustomerLanguage()

Declaration

NSCustomerLanguage GetCustomerLanguage()

Examples

NSContactEntity thing;
NSCustomerLanguage customerLanguage = thing.GetCustomerLanguage();

Returns

Type Description
NSCustomerLanguage language.

GetCustomFields()

Gets the user-defined + extra fields on an NSContactEntity as a map.

Declaration

Map GetCustomFields()

Examples

NSContactEntity thing;
Map fields = thing.GetCustomFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

Returns

Type Description
Map

GetDbiAgentId()

Declaration

Integer GetDbiAgentId()

Examples

NSContactEntity thing;
Integer dbiAgentId = thing.GetDbiAgentId();

Returns

Type Description
Integer Integration agent (eJournal).

GetDbiKey()

Declaration

String GetDbiKey()

Examples

NSContactEntity thing;
String dbiKey = thing.GetDbiKey();

Returns

Type Description
String The primary key for the integrated entry in the external data source.

GetDbiLastModified()

Declaration

DateTime GetDbiLastModified()

Examples

NSContactEntity thing;
DateTime dbiLastModified = thing.GetDbiLastModified();

Returns

Type Description
DateTime When the entry was last modified.

GetDbiLastSyncronized()

Declaration

DateTime GetDbiLastSyncronized()

Examples

NSContactEntity thing;
DateTime dbiLastSyncronized = thing.GetDbiLastSyncronized();

Returns

Type Description
DateTime Last external synchronization.

GetDeleted()

Declaration

Integer GetDeleted()

Examples

NSContactEntity thing;
Integer deleted = thing.GetDeleted();

Returns

Type Description
Integer If nonzero, then this contact is 'deleted' and should generally not be shown.

GetDepartment()

Declaration

String GetDepartment()

Examples

NSContactEntity thing;
String department = thing.GetDepartment();

Returns

Type Description
String Department.

GetDescription()

Declaration

String GetDescription()

Examples

NSContactEntity thing;
String description = thing.GetDescription();

Returns

Type Description
String Description of the contact. Usually shown as a post-it note.

GetEmails()

Declaration

NSEntityElement[] GetEmails()

Examples

NSContactEntity thing;
NSEntityElement[] emails = thing.GetEmails();

Returns

Type Description
NSEntityElement[] The contact's email.

GetExtraFields()

Gets the extra fields on NSContactEntity as a map.

Declaration

Map GetExtraFields()

Examples

NSContactEntity thing;
Map fields = thing.GetExtraFields();
String oldValue = fields.get("x_foobar");
fields.insert("x_foobar", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

Returns

Type Description
Map Map containing extra field values by field name.

GetFaxes()

Declaration

NSEntityElement[] GetFaxes()

Examples

NSContactEntity thing;
NSEntityElement[] faxes = thing.GetFaxes();

Returns

Type Description
NSEntityElement[] The contact's fax numbers.

GetGroupId()

Declaration

Integer GetGroupId()

Examples

NSContactEntity thing;
Integer groupId = thing.GetGroupId();

Returns

Type Description
Integer Group ID of original owning associate, semantics like appnt.grp_id.

GetInterests()

Declaration

NSSelectableMDOListItem[] GetInterests()

Examples

NSContactEntity thing;
NSSelectableMDOListItem[] interests = thing.GetInterests();

Returns

Type Description
NSSelectableMDOListItem[] The contact's available and selected interests.

GetKananame()

Declaration

String GetKananame()

Examples

NSContactEntity thing;
String kananame = thing.GetKananame();

Returns

Type Description
String Contact kana name, used in Japanese versions only.

GetName()

Declaration

String GetName()

Examples

NSContactEntity thing;
String name = thing.GetName();

Returns

Type Description
String Contact name.

GetNoMailing()

Declaration

Bool GetNoMailing()

Examples

NSContactEntity thing;
Bool noMailing = thing.GetNoMailing();

Returns

Type Description
Bool Spam filter. Indicates if this contact should retrieve advertising.

GetNumber1()

Declaration

String GetNumber1()

Examples

NSContactEntity thing;
String number1 = thing.GetNumber1();

Returns

Type Description
String Alphanumeric user field.

GetNumber2()

Declaration

String GetNumber2()

Examples

NSContactEntity thing;
String number2 = thing.GetNumber2();

Returns

Type Description
String Alphanumeric user field.

GetOrgNr()

Declaration

String GetOrgNr()

Examples

NSContactEntity thing;
String orgNr = thing.GetOrgNr();

Returns

Type Description
String VAT number or similar.

GetPersons()

Declaration

NSPerson[] GetPersons()

Examples

NSContactEntity thing;
NSPerson[] persons = thing.GetPersons();

Returns

Type Description
NSPerson[] The persons belonging to the contact.

GetPhones()

Declaration

NSEntityElement[] GetPhones()

Examples

NSContactEntity thing;
NSEntityElement[] phones = thing.GetPhones();

Returns

Type Description
NSEntityElement[] The contact's phone numbers.

GetSource()

Declaration

Integer GetSource()

Examples

NSContactEntity thing;
Integer source = thing.GetSource();

Returns

Type Description
Integer How did we get this contact?

GetSupportAssociate()

Declaration

NSAssociate GetSupportAssociate()

Examples

NSContactEntity thing;
NSAssociate supportAssociate = thing.GetSupportAssociate();

Returns

Type Description
NSAssociate

GetSupportPerson()

Declaration

NSPerson GetSupportPerson()

Examples

NSContactEntity thing;
NSPerson supportPerson = thing.GetSupportPerson();

Returns

Type Description
NSPerson

GetTicketPriority()

Declaration

NSTicketPriority GetTicketPriority()

Examples

NSContactEntity thing;
NSTicketPriority ticketPriority = thing.GetTicketPriority();

Returns

Type Description
NSTicketPriority

GetUpdatedBy()

Declaration

NSAssociate GetUpdatedBy()

Examples

NSContactEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

Returns

Type Description
NSAssociate The user that last updated the contact.

GetUpdatedDate()

Declaration

DateTime GetUpdatedDate()

Examples

NSContactEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();

Returns

Type Description
DateTime Date last updated.

GetUrls()

Declaration

NSEntityElement[] GetUrls()

Examples

NSContactEntity thing;
NSEntityElement[] urls = thing.GetUrls();

Returns

Type Description
NSEntityElement[] The contact's internet address.

GetUserDefinedFields()

Gets the user-defined fields on the NSContactEntity as a map.

Declaration

Map GetUserDefinedFields()

Examples

NSContactEntity thing;
Map fields = thing.GetUserDefinedFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

Returns

Type Description
Map Map containing user defined field values by field prog.id.

GetXstop()

Declaration

Bool GetXstop()

Examples

NSContactEntity thing;
Bool xstop = thing.GetXstop();

Returns

Type Description
Bool STOP flag.

SetActiveErpLinks(Integer)

Declaration

Void SetActiveErpLinks(Integer activeErpLinks)

Examples

NSContactEntity thing;
Integer activeErpLinks;
thing.SetActiveErpLinks(activeErpLinks);

Parameters

Type Name Description
Integer activeErpLinks The number of active ERP links.

Returns

Type Description
Void

SetActiveInterests(Integer)

Declaration

Void SetActiveInterests(Integer activeInterests)

Examples

NSContactEntity thing;
Integer activeInterests;
thing.SetActiveInterests(activeInterests);

Parameters

Type Name Description
Integer activeInterests The number of active interests.

Returns

Type Description
Void

SetActiveStatusMonitorId(Integer)

Declaration

Void SetActiveStatusMonitorId(Integer activeStatusMonitorId)

Examples

NSContactEntity thing;
Integer activeStatusMonitorId;
thing.SetActiveStatusMonitorId(activeStatusMonitorId);

Parameters

Type Name Description
Integer activeStatusMonitorId Active status monitor identity with the lowest rank for contact.

Returns

Type Description
Void

SetAddress(NSLocalizedField[][])

Sets a contact's address. You can pass either an NSAddress object or NSLocalizedField[][].

Declaration

Void SetAddress(NSLocalizedField[][] address)

Examples

NSContactEntity thing;
NSAddress address;
thing.SetAddress(address);

Parameters

Type Name Description
address

Returns

Type Description
Void

SetAssociate(NSAssociate)

Declaration

Void SetAssociate(NSAssociate associate)

Examples

NSContactEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);

Parameters

Type Name Description
NSAssociate associate The user that owns this contact.

Returns

Type Description
Void

SetBounceEmails(String[])

Declaration

Void SetBounceEmails(String[] bounceEmails)

Examples

NSContactEntity thing;
String[] bounceEmails;
thing.SetBounceEmails(bounceEmails);

Parameters

Type Name Description
String[] bounceEmails Email addresses with a positive bounce counter.

Returns

Type Description
Void

SetBusiness(NSBusiness)

Declaration

Void SetBusiness(NSBusiness business)

Examples

NSContactEntity thing;
NSBusiness business;
thing.SetBusiness(business);

Parameters

Type Name Description
NSBusiness business The business that the contact is associated with.

Returns

Type Description
Void

SSetCategory(NSCategory)

Declaration

Void SetCategory(NSCategory category)

Examples

NSContactEntity thing;
NSCategory category;
thing.SetCategory(category);

Parameters

Type Name Description
NSCategory category The category that is set on the company.

Returns

Type Description
Void

SetContactId(Integer)

Declaration

Void SetContactId(Integer contactId)

Examples

NSContactEntity thing;
Integer contactId;
thing.SetContactId(contactId);

Parameters

Type Name Description
Integer contactId Primary key.

Returns

Type Description
Void

SetCountry(NSCountry)

Declaration

Void SetCountry(NSCountry country)

Examples

NSContactEntity thing;
NSCountry country;
thing.SetCountry(country);

Parameters

Type Name Description
NSCountry country The country this contact is located in.

Returns

Type Description
Void

SetCreatedBy(NSAssociate)

Declaration

Void SetCreatedBy(NSAssociate createdBy)

Examples

NSContactEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

Parameters

Type Name Description
NSAssociate createdBy The user that created the contact.

Returns

Type Description
Void

SetCreatedDate(DateTime)

Declaration

Void SetCreatedDate(DateTime createdDate)

Examples

NSContactEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);

Parameters

Type Name Description
DateTime createdDate Date registered.

Returns

Type Description
Void

SetCustomerLanguage(NSCustomerLanguage)

Declaration

Void SetCustomerLanguage(NSCustomerLanguage customerLanguage)

Examples

NSContactEntity thing;
NSCustomerLanguage customerLanguage;
thing.SetCustomerLanguage(customerLanguage);

Parameters

Type Name Description
NSCustomerLanguage customerLanguage

Returns

Type Description
Void

SetCustomFields(Map)

Sets the user-defined and extra fields on an NSContactEntity with a map.

Declaration

Void SetCustomFields(Map udefs)

Examples

NSContactEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
udefs["x_foo"] = "foobar";
udefs["x_bar"] = "456"; // List item id
thing.SetCustomFields(udefs);

Parameters

Type Name Description
Map udefs

Returns

Type Description
Void

SetDbiAgentId(Integer)

Declaration

Void SetDbiAgentId(Integer dbiAgentId)

Examples

NSContactEntity thing;
Integer dbiAgentId;
thing.SetDbiAgentId(dbiAgentId);

Parameters

Type Name Description
Integer dbiAgentId Integration agent (eJournal).

Returns

Type Description
Void

SetDbiKey(String)

Declaration

Void SetDbiKey(String dbiKey)

Examples

NSContactEntity thing;
String dbiKey;
thing.SetDbiKey(dbiKey);

Parameters

Type Name Description
String dbiKey The primary key for the integrated entry in the external data source.

Returns

Type Description
Void

SetDbiLastModified(DateTime)

Declaration

Void SetDbiLastModified(DateTime dbiLastModified)

Examples

NSContactEntity thing;
DateTime dbiLastModified;
thing.SetDbiLastModified(dbiLastModified);

Parameters

Type Name Description
DateTime dbiLastModified When the entry was last modified.

Returns

Type Description
Void

SetDbiLastSyncronized(DateTime)

Declaration

Void SetDbiLastSyncronized(DateTime dbiLastSyncronized)

Examples

NSContactEntity thing;
DateTime dbiLastSyncronized;
thing.SetDbiLastSyncronized(dbiLastSyncronized);

Parameters

Type Name Description
DateTime dbiLastSyncronized Last external synchronization.

Returns

Type Description
Void

SetDeleted(Integer)

Declaration

Void SetDeleted(Integer deleted)

Examples

NSContactEntity thing;
Integer deleted;
thing.SetDeleted(deleted);

Parameters

Type Name Description
Integer deleted If nonzero, then this contact is 'deleted' and should generally not be shown.

Returns

Type Description
Void

SetDepartment(String)

\n

Declaration

Void SetDepartment(String department)

Examples

NSContactEntity thing;
String department;
thing.SetDepartment(department);

Parameters

Type Name Description
String department nDepartment.

Returns

Type Description
Void

SetDescription(String)

Declaration

Void SetDescription(String description)

Examples

NSContactEntity thing;
String description;
thing.SetDescription(description);

Parameters

Type Name Description
String description Description of the contact. Usually shown as a post-it note.

Returns

Type Description
Void

SetEmails(NSEntityElement[])

Declaration

Void SetEmails(NSEntityElement[] emails)

Examples

NSContactEntity thing;
NSEntityElement[] emails;
thing.SetEmails(emails);

Parameters

Type Name Description
NSEntityElement[] emails The contact's email.

Returns

Type Description
Void

SetExtraFields(Map)

Sets the extra field values on NSContactEntity with a map.

Declaration

Void SetExtraFields(Map extras)

Examples

NSContactEntity thing;
Map extras;
extras["SuperOffice:1"] = "[I:123]";
extras["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
extras["custom.progid"] = "foobar";
thing.SetExtraFields(extras);

Parameters

Type Name Description
Map extras

Returns

Type Description
Void

SetFaxes(NSEntityElement[])

Declaration

Void SetFaxes(NSEntityElement[] faxes)

Examples

NSContactEntity thing;
NSEntityElement[] faxes;
thing.SetFaxes(faxes);

Parameters

Type Name Description
NSEntityElement[] faxes The contact's fax numbers.

Returns

Type Description
Void

SetGroupId(Integer)

Declaration

Void SetGroupId(Integer groupId)

Examples

NSContactEntity thing;
Integer groupId;
thing.SetGroupId(groupId);

Parameters

Type Name Description
Integer groupId Group ID of original owning associate, semantics like appnt.grp_id.

Returns

Type Description
Void

SetInterests(NSSelectableMDOListItem[])

Declaration

Void SetInterests(NSSelectableMDOListItem[] interests)

Examples

NSContactEntity thing;
NSSelectableMDOListItem[] interests;
thing.SetInterests(interests);

Parameters

Type Name Description
NSSelectableMDOListItem[] interests The contact's available and selected interests.

Returns

Type Description
Void

SetKananame(String)

Declaration

Void SetKananame(String kananame)

Examples

NSContactEntity thing;
String kananame;
thing.SetKananame(kananame);

Parameters

Type Name Description
String kananame Contact kana name, used in Japanese versions only.

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

NSContactEntity thing;
String name;
thing.SetName(name);

Parameters

Type Name Description
String name Contact name.

Returns

Type Description
Void

SetNoMailing(Bool)

Declaration

Void SetNoMailing(Bool noMailing)

Examples

NSContactEntity thing;
Bool noMailing;
thing.SetNoMailing(noMailing);

Parameters

Type Name Description
Bool noMailing Spam filter. Indicates if this contact should retrieve advertising.

Returns

Type Description
Void

SetNumber1(String)

Declaration

Void SetNumber1(String number1)

Examples

NSContactEntity thing;
String number1;
thing.SetNumber1(number1);

Parameters

Type Name Description
String number1 Alphanumeric user field.

Returns

Type Description
Void

SetNumber2(String)

Declaration

Void SetNumber2(String number2)

Examples

NSContactEntity thing;
String number2;
thing.SetNumber2(number2);

Parameters

Type Name Description
String number2 Alphanumeric user field.

Returns

Type Description
Void

SetOrgNr(String)

Declaration

Void SetOrgNr(String orgNr)

Examples

NSContactEntity thing;
String orgNr;
thing.SetOrgNr(orgNr);

Parameters

Type Name Description
String orgNr VAT number or similar.

Returns

Type Description
Void

SetPersons(NSPerson[])

Declaration

Void SetPersons(NSPerson[] persons)

Examples

NSContactEntity thing;
NSPerson[] persons;
thing.SetPersons(persons);

Parameters

Type Name Description
NSPerson[] persons The persons belonging to the contact.

Returns

Type Description
Void

SetPhones(NSEntityElement[])

Declaration

Void SetPhones(NSEntityElement[] phones)

Examples

NSContactEntity thing;
NSEntityElement[] phones;
thing.SetPhones(phones);

Parameters

Type Name Description
NSEntityElement[] phones The contact's phone numbers.

Returns

Type Description
Void

SetSource(Integer)

Declaration

Void SetSource(Integer source)

Examples

NSContactEntity thing;
Integer source;
thing.SetSource(source);

Parameters

Type Name Description
Integer source How did we get this contact?

Returns

Type Description
Void

SetSupportAssociate(NSAssociate)

Declaration

Void SetSupportAssociate(NSAssociate supportAssociate)

Examples

NSContactEntity thing;
NSAssociate supportAssociate;
thing.SetSupportAssociate(supportAssociate);

Parameters

Type Name Description
NSAssociate supportAssociate

Returns

Type Description
Void

SetSupportPerson(NSPerson)

Declaration

Void SetSupportPerson(NSPerson supportPerson)

Examples

NSContactEntity thing;
NSPerson supportPerson;
thing.SetSupportPerson(supportPerson);

Parameters

Type Name Description
NSPerson supportPerson

Returns

Type Description
Void

SetTicketPriority(NSTicketPriority)

Declaration

Void SetTicketPriority(NSTicketPriority ticketPriority)

Examples

NSContactEntity thing;
NSTicketPriority ticketPriority;
thing.SetTicketPriority(ticketPriority);

Parameters

Type Name Description
NSTicketPriority ticketPriority

Returns

Type Description
Void

SetUpdatedBy(NSAssociate)

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Examples

NSContactEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

Parameters

Type Name Description
NSAssociate updatedBy The user that last updated the contact.

Returns

Type Description
Void

SetUpdatedDate(DateTime)

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Examples

NSContactEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);

Parameters

Type Name Description
DateTime updatedDate Date last updated.

Returns

Type Description
Void

SetUrls(NSEntityElement[])

Declaration

Void SetUrls(NSEntityElement[] urls)

Examples

NSContactEntity thing;
NSEntityElement[] urls;
thing.SetUrls(urls);

Parameters

Type Name Description
NSEntityElement[] urls The contact's internet addresses.

Returns

Type Description
Void

SetUserDefinedFields(Map)

Sets the user-defined fields on the NSContactEntity as a map.

Declaration

Void SetUserDefinedFields(Map udefs)

Examples

NSContactEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
thing.SetUserDefinedFields(udefs);

Parameters

Type Name Description
Map udefs

Returns

Type Description
Void

SetXstop(Bool)

Declaration

Void SetXstop(Bool xstop)

Examples

NSContactEntity thing;
Bool xstop;
thing.SetXstop(xstop);

Parameters

Type Name Description
Bool xstop STOP flag.

Returns

Type Description
Void