Class NSAppointmentEntity
Appointments appear in the diary, and have links to a Contact/Person and possibly a Project or Sale. They have start and end time+date.
Syntax
Constructors
NSAppointmentEntity()
Initializes a new instance of the NSAppointmentEntity class.
Introduced or updated in version: 7
Declaration
NSAppointmentEntityMethods
GetActiveDate()
Introduced or updated in version: 7
Declaration
DateTime GetActiveDate()Returns
| Type | Description |
|---|---|
| DateTime | The date to be used for searching and showing. |
Examples
NSAppointmentEntity thing;
DateTime activeDate = thing.GetActiveDate();GetActiveLinks()
Introduced or updated in version: 7
Declaration
Integer GetActiveLinks()Returns
| Type | Description |
|---|---|
| Integer | Number of active links to sale, document, appointment. |
Examples
NSAppointmentEntity thing;
Integer activeLinks = thing.GetActiveLinks();GetAlarmLeadTime()
Introduced or updated in version: 7
Declaration
TimeSpan GetAlarmLeadTime()Returns
| Type | Description |
|---|---|
| TimeSpan | Alarm lead time. |
Examples
NSAppointmentEntity thing;
TimeSpan alarmLeadTime = thing.GetAlarmLeadTime();GetAlldayEvent()
Introduced or updated in version: 7
Declaration
Bool GetAlldayEvent()Returns
| Type | Description |
|---|---|
| Bool | True if this is an all day event. |
GetAppointmentId()
Introduced or updated in version: 7
Declaration
Integer GetAppointmentId()Returns
| Type | Description |
|---|---|
| Integer | Primary key. |
Examples
NSAppointmentEntity thing;
Integer appointmentId = thing.GetAppointmentId();GetAssignedBy()
Introduced or updated in version: 7
Declaration
NSAssociate GetAssignedBy()Returns
| Type | Description |
|---|---|
| NSAssociate | Who assigned this appointment to this user? Whose diary did the appointment come from? |
Examples
NSAppointmentEntity thing;
NSAssociate assignedBy = thing.GetAssignedBy();GetAssignmentStatus()
Introduced or updated in version: 7.5
Declaration
Integer GetAssignmentStatus()Returns
| Type | Description |
|---|---|
| Integer | Status if this appointment is in the process of being assigned to someone else. |
Examples
NSAppointmentEntity thing;
Integer assignmentStatus = thing.GetAssignmentStatus();GetAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate | The owner of the appointment - the associate whose diary/checklist the appointment is in. |
Examples
NSAppointmentEntity thing;
NSAssociate associate = thing.GetAssociate();GetBookingType()
Introduced or updated in version: 7.5
Declaration
Integer GetBookingType()Returns
| Type | Description |
|---|---|
| Integer | The type of booking the appointment represents. |
Examples
NSAppointmentEntity thing;
Integer bookingType = thing.GetBookingType();GetCautionWarning()
Introduced or updated in version: 7
Declaration
Integer GetCautionWarning()Returns
| Type | Description |
|---|---|
| Integer | Status field to indicate appointments that have some sort of problem. See AppointmentCautionWarning |
Examples
NSAppointmentEntity thing;
Integer cautionWarning = thing.GetCautionWarning();GetCentralserviceVideomeetId()
Introduced or updated in version: 7
Declaration
String GetCentralserviceVideomeetId()Returns
| Type | Description |
|---|---|
| String | GUID for video meeting in central services. |
Remarks
This is set when we create meetings from SuperOffice. It is blank for incoming meetings created from inbox.
Examples
NSAppointmentEntity thing;
String centralserviceVideomeetId = thing.GetCentralserviceVideomeetId();GetColorIndex()
Introduced or updated in version: 7
Declaration
Integer GetColorIndex()Returns
| Type | Description |
|---|---|
| Integer | Appointment colour, used only in Japanese versions. Western versions take colour from Task. See ColorIndex. |
Examples
NSAppointmentEntity thing;
Integer colorIndex = thing.GetColorIndex();GetCompleted()
Introduced or updated in version: 7
Declaration
Integer GetCompleted()Returns
| Type | Description |
|---|---|
| Integer | Appointment Completed state. |
Remarks
This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set.
Examples
NSAppointmentEntity thing;
Integer completed = thing.GetCompleted();GetContact()
Introduced or updated in version: 7
Declaration
NSContact GetContact()Returns
| Type | Description |
|---|---|
| NSContact | The contact associated with the appointment. It may also be null if no contact is associated with the appointment. |
Examples
NSAppointmentEntity thing;
NSContact contact = thing.GetContact();GetCreatedBy()
Introduced or updated in version: 7
Declaration
NSAssociate GetCreatedBy()Returns
| Type | Description |
|---|---|
| NSAssociate | The associate that first created the appointment. |
Remarks
The property is read-only.
Examples
NSAppointmentEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();GetCreatedDate()
Introduced or updated in version: 7
Declaration
DateTime GetCreatedDate()Returns
| Type | Description |
|---|---|
| DateTime | Registered date. |
Examples
NSAppointmentEntity thing;
DateTime createdDate = thing.GetCreatedDate();GetCustomFields()
Gets the user-defined + extra fields on an NSAppointmentEntity as a map.
Introduced or updated in version: 8.5R08
Declaration
Map GetCustomFields()Returns
| Type | Description |
|---|---|
| Map | Map containing user defined and extra field values by field name. |
Examples
NSAppointmentEntity 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());GetDescription()
Introduced or updated in version: 7
Declaration
String GetDescription()Returns
| Type | Description |
|---|---|
| String | Description of the appointment. |
Examples
NSAppointmentEntity thing;
String description = thing.GetDescription();GetEndDate()
Introduced or updated in version: 7
Declaration
DateTime GetEndDate()Returns
| Type | Description |
|---|---|
| DateTime | Date + end time planned. |
Examples
NSAppointmentEntity thing;
DateTime endDate = thing.GetEndDate();GetExtraFields()
Gets the extra fields on NSAppointmentEntity as a map.
Introduced or updated in version: 7
Declaration
Map GetExtraFields()Returns
| Type | Description |
|---|---|
| Map | Map containing extra field values by field name. |
Examples
NSAppointmentEntity 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());GetFreeBusy()
Introduced or updated in version: 7
Declaration
Bool GetFreeBusy()Returns
| Type | Description |
|---|---|
| Bool | What kind of time is this? False is Busy. True is Free. |
GetHasAlarm()
Introduced or updated in version: 7
Declaration
Bool GetHasAlarm()Returns
| Type | Description |
|---|---|
| Bool | Does this appointment have an alarm? |
Examples
NSAppointmentEntity thing;
Bool hasAlarm = thing.GetHasAlarm();GetHasConflict()
Introduced or updated in version: 7
Declaration
Bool GetHasConflict()Returns
| Type | Description |
|---|---|
| Bool | Does the appointment overlap with another appointment in the user's diary? |
Examples
NSAppointmentEntity thing;
Bool hasConflict = thing.GetHasConflict();GetInvitationStatus()
Introduced or updated in version: 7.5
Declaration
Integer GetInvitationStatus()Returns
| Type | Description |
|---|---|
| Integer | Status if this appointment represents an invitation. |
Examples
NSAppointmentEntity thing;
Integer invitationStatus = thing.GetInvitationStatus();GetInvitedPerson()
Introduced or updated in version: 7
Declaration
NSPerson GetInvitedPerson()Returns
| Type | Description |
|---|---|
| NSPerson | If the appointment is a booking, the invited persons may be your associates, but you are also able to invite contact persons from other companies to join your meeting. They do not receive an invitation, unless you send them one by email, but you can see in the appointment that persons other than your associates have been invited to a meeting. Each invited person will have an appointment slave record. |
Examples
NSAppointmentEntity thing;
NSPerson invitedPerson = thing.GetInvitedPerson();GetIsAlldayEvent()
Introduced or updated in version: 7.5
Declaration
Bool GetIsAlldayEvent()Returns
| Type | Description |
|---|---|
| Bool | True if all day event. |
Examples
NSAppointmentEntity thing;
Bool isAlldayEvent = thing.GetIsAlldayEvent();GetIsFree()
Introduced or updated in version: 7.5
Declaration
Bool GetIsFree()Returns
| Type | Description |
|---|---|
| Bool | True if free, false if busy. |
Examples
NSAppointmentEntity thing;
Bool isFree = thing.GetIsFree();GetIsMileStone()
Introduced or updated in version: 7.1.1
Declaration
Bool GetIsMileStone()Returns
| Type | Description |
|---|---|
| Bool | Is this appointment a milestone? |
Examples
NSAppointmentEntity thing;
Bool isMileStone = thing.GetIsMileStone();GetIsPublished()
Introduced or updated in version: 7
Declaration
Bool GetIsPublished()Returns
| Type | Description |
|---|---|
| Bool | Should this NSAppointmentEntity be published and visible to strangers? |
GetJoinVideomeetUrl()
Introduced or updated in version: 7
Declaration
String GetJoinVideomeetUrl()Returns
| Type | Description |
|---|---|
| String | Blank when not a video meeting. Filled with Join Meeting URL when created. |
Examples
NSAppointmentEntity thing;
String joinVideomeetUrl = thing.GetJoinVideomeetUrl();GetLagTime()
Introduced or updated in version: 7
Declaration
TimeSpan GetLagTime()Returns
| Type | Description |
|---|---|
| TimeSpan | As leadtime, but after the end - time blocked for travel and so on. |
Examples
NSAppointmentEntity thing;
TimeSpan lagTime = thing.GetLagTime();GetLeadTime()
Introduced or updated in version: 7
Declaration
TimeSpan GetLeadTime()Returns
| Type | Description |
|---|---|
| TimeSpan | Time blocked (minutes) BEFORE starttime. |
Examples
NSAppointmentEntity thing;
TimeSpan leadTime = thing.GetLeadTime();GetLinks()
Introduced or updated in version: 7
Declaration
NSLink[] GetLinks()Returns
| Type | Description |
|---|---|
| NSLink[] | List of all elements linked to the appointment. |
Examples
NSAppointmentEntity thing;
NSLink[] links = thing.GetLinks();GetLocation()
Introduced or updated in version: 7
Declaration
String GetLocation()Returns
| Type | Description |
|---|---|
| String | Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here. |
Examples
NSAppointmentEntity thing;
String location = thing.GetLocation();GetMotherAssociate()
Introduced or updated in version: 7
Declaration
NSAssociate GetMotherAssociate()Returns
| Type | Description |
|---|---|
| NSAssociate | The owner of the mother appointment - the associate whose diary/checklist the mother appointment is in. |
Remarks
The mother appointment is the one identified by the mother_id. If the mother_id is 0 or the same as this appointment_id, then the master associate will be the same as the 'ordinary' associate.
Examples
NSAppointmentEntity thing;
NSAssociate motherAssociate = thing.GetMotherAssociate();GetMotherId()
Introduced or updated in version: 7
Declaration
Integer GetMotherId()Returns
| Type | Description |
|---|---|
| Integer | ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. However, if 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking. |
Examples
NSAppointmentEntity thing;
Integer motherId = thing.GetMotherId();GetParticipants()
Introduced or updated in version: 7
Declaration
NSParticipantInfo[] GetParticipants()Returns
| Type | Description |
|---|---|
| NSParticipantInfo[] | List of IDs of the participants to this appointment. |
Examples
NSAppointmentEntity thing;
NSParticipantInfo[] participants = thing.GetParticipants();GetPerson()
Introduced or updated in version: 7
Declaration
NSPerson GetPerson()Returns
| Type | Description |
|---|---|
| NSPerson | An appointment may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required. |
Examples
NSAppointmentEntity thing;
NSPerson person = thing.GetPerson();GetPreferredTZLocation()
Introduced or updated in version: 7
Declaration
Integer GetPreferredTZLocation()Returns
| Type | Description |
|---|---|
| Integer | Appointment's preferred timezone location. |
Examples
NSAppointmentEntity thing;
Integer preferredTZLocation = thing.GetPreferredTZLocation();GetPriority()
It's possible to give appointments different priorities. All the different priority types are saved in the priority table, and edited from the Admin Client. An appointment does not require a priority.
Introduced or updated in version: 7
Declaration
NSPriority GetPriority()Returns
| Type | Description |
|---|---|
| NSPriority |
Examples
NSAppointmentEntity thing;
NSPriority priority = thing.GetPriority();GetPrivate()
Introduced or updated in version: 7
Declaration
Integer GetPrivate()Returns
| Type | Description |
|---|---|
| Integer | The confidentiality of appointments is shown as different types of private on the appointment. See AppointmentPrivate |
Examples
NSAppointmentEntity thing;
Integer private = thing.GetPrivate();GetProject()
Introduced or updated in version: 7
Declaration
NSProject GetProject()Returns
| Type | Description |
|---|---|
| NSProject | An appointment may also be connected to a project, so you see the appointment both on the company card, and on the project card. This does not mean however that a project is required. |
Examples
NSAppointmentEntity thing;
NSProject project = thing.GetProject();GetPublishEventDate()
Introduced or updated in version: 7
Declaration
DateTime GetPublishEventDate()Returns
| Type | Description |
|---|---|
| DateTime | Publish event date on NSAppointmentEntity. |
GetPublishFrom()
Introduced or updated in version: 7
Declaration
DateTime GetPublishFrom()Returns
| Type | Description |
|---|---|
| DateTime | Publish from date on NSAppointmentEntity. |
GetPublishTo()
Introduced or updated in version: 7
Declaration
DateTime GetPublishTo()Returns
| Type | Description |
|---|---|
| DateTime | Publish to date on NSAppointmentEntity. After this date the event is no longer visible. |
GetRecurrence()
Introduced or updated in version: 7
Declaration
NSRecurrenceInfo GetRecurrence()Returns
| Type | Description |
|---|---|
| NSRecurrenceInfo | The appointment recurrence. |
Examples
NSAppointmentEntity thing;
NSRecurrenceInfo recurrence = thing.GetRecurrence();GetRejectCounter()
Introduced or updated in version: 7
Declaration
Integer GetRejectCounter()Returns
| Type | Description |
|---|---|
| Integer | How many invitees have rejected this appointment? |
Examples
NSAppointmentEntity thing;
Integer rejectCounter = thing.GetRejectCounter();GetRejectReason()
Introduced or updated in version: 7
Declaration
String GetRejectReason()Returns
| Type | Description |
|---|---|
| String | Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here. |
Examples
NSAppointmentEntity thing;
String rejectReason = thing.GetRejectReason();GetSale()
Introduced or updated in version: 7
Declaration
NSSale GetSale()Returns
| Type | Description |
|---|---|
| NSSale | An appointment may also be connected to a sale, so you see the appointment on the company card, on the project card and on the sale card. This does not mean however that a sale is required. |
Examples
NSAppointmentEntity thing;
NSSale sale = thing.GetSale();GetStartDate()
Introduced or updated in version: 7
Declaration
DateTime GetStartDate()Returns
| Type | Description |
|---|---|
| DateTime | date + start time planned. |
Examples
NSAppointmentEntity thing;
DateTime startDate = thing.GetStartDate();GetSuggestedAppointmentId()
Introduced or updated in version: 7
Declaration
Integer GetSuggestedAppointmentId()Returns
| Type | Description |
|---|---|
| Integer | Suggested guide item that this appointment is an instance of |
Remarks
NOT VALID for document-type appointments, they have their own link
Examples
NSAppointmentEntity thing;
Integer suggestedAppointmentId = thing.GetSuggestedAppointmentId();GetTask()
Introduced or updated in version: 7
Declaration
NSTaskListItem GetTask()Returns
| Type | Description |
|---|---|
| NSTaskListItem | Task comprises the different types of activities, such as Phone call or Meeting. |
Examples
NSAppointmentEntity thing;
NSTaskListItem task = thing.GetTask();GetType()
Introduced or updated in version: 7
Declaration
Integer GetType()Returns
| Type | Description |
|---|---|
| Integer | The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. |
Examples
NSAppointmentEntity thing;
Integer type = thing.GetType();GetUpdatedBy()
Introduced or updated in version: 7
Declaration
NSAssociate GetUpdatedBy()Returns
| Type | Description |
|---|---|
| NSAssociate | The person that last updated the appointment. |
Examples
NSAppointmentEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();GetUpdatedDate()
Introduced or updated in version: 7
Declaration
DateTime GetUpdatedDate()Returns
| Type | Description |
|---|---|
| DateTime | Updated date. |
Examples
NSAppointmentEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();GetUserDefinedFields()
Gets the user-defined fields on the NSAppointmentEntity as a map.
Introduced or updated in version: 7
Declaration
Map GetUserDefinedFields()Returns
| Type | Description |
|---|---|
| Map | Map containing user defined field values by field prog.id. |
Examples
NSAppointmentEntity 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());GetVisibleFor()
Returns the usergroups and/or users the NSAppointmentEntity item is visible for.
Introduced or updated in version: 7
Declaration
NSVisibleFor[] GetVisibleFor()Returns
| Type | Description |
|---|---|
| NSVisibleFor[] | Visible for array. |
Examples
NSAppointmentEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();SetActiveDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetActiveDate(DateTime activeDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | activeDate | The date to be used for searching and showing. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
DateTime activeDate;
thing.SetActiveDate(activeDate);SetActiveLinks(Integer)
Introduced or updated in version: 7
Declaration
Void SetActiveLinks(Integer activeLinks)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | activeLinks | Number of active links to sale, document, appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer activeLinks;
thing.SetActiveLinks(activeLinks);SetAlarmLeadTime(TimeSpan)
Introduced or updated in version: 7
Declaration
Void SetAlarmLeadTime(TimeSpan alarmLeadTime)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | alarmLeadTime | Alarm lead time. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
TimeSpan alarmLeadTime;
thing.SetAlarmLeadTime(alarmLeadTime);SetAlldayEvent(Bool)
Introduced or updated in version: 7
Declaration
Void SetAlldayEvent(Bool isAllDayEvent)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isAllDayEvent | True if this is an all day event. |
Returns
| Type | Description |
|---|---|
| Void |
SetAppointmentId(Integer)
Introduced or updated in version: 7
Declaration
Void SetAppointmentId(Integer appointmentId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | appointmentId | Primary key. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);SetAssignedBy(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetAssignedBy(NSAssociate assignedBy)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | assignedBy | Who assigned this appointment to this user? Whose diary did the appointment come from? |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSAssociate assignedBy;
thing.SetAssignedBy(assignedBy);SetAssignmentStatus(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetAssignmentStatus(Integer assignmentStatus)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | assignmentStatus | Status if this appointment is in the process of being assigned to someone else. See AssignmentStatus |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer assignmentStatus;
thing.SetAssignmentStatus(assignmentStatus);SetAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetAssociate(NSAssociate associate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | associate | The owner of the appointment - the associate whose diary/checklist the appointment is in. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);SetBookingType(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetBookingType(Integer bookingType)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | bookingType | The type of booking the appointment represents. See BookingType. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer bookingType;
thing.SetBookingType(bookingType);SetCautionWarning(Integer)
Introduced or updated in version: 7
Declaration
Void SetCautionWarning(Integer cautionWarning)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | cautionWarning | Status field to indicate appointments that have some sort of problem. See AppointmentCautionWarning. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer cautionWarning;
thing.SetCautionWarning(cautionWarning);SetCentralserviceVideomeetId(String)
Introduced or updated in version: 7
Declaration
Void SetCentralserviceVideomeetId(String centralserviceVideomeetId)Parameters
| Type | Name | Description |
|---|---|---|
| String | centralserviceVideomeetId | GUID for video meeting in central services – this is set when we create meetings from SuperOffice. It is blank for incoming meetings created from inbox. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
String centralserviceVideomeetId;
thing.SetCentralserviceVideomeetId(centralserviceVideomeetId);SetColorIndex(Integer)
Introduced or updated in version: 7
Declaration
Void SetColorIndex(Integer colorIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | colorIndex | Appointment colour, used only in Japanese versions. Western versions take colour from Task. See ColorIndex. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer colorIndex;
thing.SetColorIndex(colorIndex);SetCompleted(Integer)
Introduced or updated in version: 7
Declaration
Void SetCompleted(Integer completed)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | completed | Appointment Completed state. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set.
Examples
NSAppointmentEntity thing;
Integer completed;
thing.SetCompleted(completed);SetContact(NSContact)
Introduced or updated in version: 7
Declaration
Void SetContact(NSContact contact)Parameters
| Type | Name | Description |
|---|---|---|
| NSContact | contact | The contact associated with the appointment. It may also be null if no contact is associated with the appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSContact contact;
thing.SetContact(contact);SetCreatedBy(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetCreatedBy(NSAssociate createdBy)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | createdBy | The associate that first created the appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
The property is read-only.
Examples
NSAppointmentEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);SetCreatedDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetCreatedDate(DateTime createdDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | createdDate | Registered date. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);SetCustomFields(Map)
Sets the user-defined and extra fields on an NSAppointmentEntity with a map.
Introduced or updated in version: 8.5R08
Declaration
Void SetCustomFields(Map udefs)Parameters
| Type | Name | Description |
|---|---|---|
| Map | udefs |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity 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);SetDescription(String)
Introduced or updated in version: 7
Declaration
Void SetDescription(String description)Parameters
| Type | Name | Description |
|---|---|---|
| String | description | Description of the appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
String description;
thing.SetDescription(description);SetEndDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetEndDate(DateTime endDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | endTime | Date + end time planned. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
DateTime endDate;
thing.SetEndDate(endDate);SetExtraFields(Map)
Sets the extra field values on NSAppointmentEntity with a map.
Introduced or updated in version: 7
Declaration
Void SetExtraFields(Map extras)Parameters
| Type | Name | Description |
|---|---|---|
| Map | extras |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity 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);SetFreeBusy(Bool)
Introduced or updated in version: 7
Declaration
Void SetFreeBusy(Bool isFreeBusy)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isFreeBusy | What kind of time is this. False is Busy. True is Free. |
Returns
| Type | Description |
|---|---|
| Void |
SetHasAlarm(Bool)
Introduced or updated in version: 7
Declaration
Void SetHasAlarm(Bool hasAlarm)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | hasAlarm | Does this appointment have an alarm. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Bool hasAlarm;
thing.SetHasAlarm(hasAlarm);SetHasConflict(Bool)
Introduced or updated in version: 7
Declaration
Void SetHasConflict(Bool hasConflict)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | hasConflict | Does the appointment overlap with another appointment in the user's diary? |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Bool hasConflict;
thing.SetHasConflict(hasConflict);SetInvitationStatus(Integer)
Introduced or updated in version: 7.5
Declaration
Void SetInvitationStatus(Integer invitationStatus)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | invitationStatus | Status if this appointment represents an invitation. See InvitationStatus. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer invitationStatus;
thing.SetInvitationStatus(invitationStatus);SetInvitedPerson(NSPerson)
Introduced or updated in version: 7
Declaration
Void SetInvitedPerson(NSPerson invitedPerson)Parameters
| Type | Name | Description |
|---|---|---|
| NSPerson | invitedPerson | If the appointment is a booking, the invited persons may be your associates, but you are also able to invite contact persons from other companies to join your meeting. They do not receive an invitation, unless you send them one by email, but you can see in the appointment that persons other than your associates have been invited to a meeting. Each invited person will have an appointment slave record. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSPerson invitedPerson;
thing.SetInvitedPerson(invitedPerson);SetIsAlldayEvent(Bool)
Introduced or updated in version: 7.5
Declaration
Void SetIsAlldayEvent(Bool isAlldayEvent)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isAlldayEvent | True if all day event. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Bool isAlldayEvent;
thing.SetIsAlldayEvent(isAlldayEvent);SetIsFree(Bool)
Introduced or updated in version: 7.5
Declaration
Void SetIsFree(Bool isFree)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isFree | True if free, false if busy. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Bool isFree;
thing.SetIsFree(isFree);SetIsMileStone(Bool)
Introduced or updated in version: 7.1.1
Declaration
Void SetIsMileStone(Bool isMileStone)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isMileStone | Is this appointment a milestone? |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Bool isMileStone;
thing.SetIsMileStone(isMileStone);SetIsPublished(Bool)
Sets the isPublished property of the appointment.
Introduced or updated in version: 7
Declaration
Void SetIsPublished(Bool isPublished)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isPublished | Should this NSAppointmentEntity be published and visible to strangers? |
Returns
| Type | Description |
|---|---|
| Void |
SetJoinVideomeetUrl(String)
Introduced or updated in version: 7
Declaration
Void SetJoinVideomeetUrl(String joinVideomeetUrl)Parameters
| Type | Name | Description |
|---|---|---|
| String | joinVideomeetUrl | Blank when not a video meeting. Filled with Join Meeting URL when created. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
String joinVideomeetUrl;
thing.SetJoinVideomeetUrl(joinVideomeetUrl);SetLagTime(TimeSpan)
Introduced or updated in version: 7
Declaration
Void SetLagTime(TimeSpan lagTime)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | lagTime | As leadtime, but after the end - time blocked for travel and so on. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
TimeSpan lagTime;
thing.SetLagTime(lagTime);SetLeadTime(TimeSpan)
Introduced or updated in version: 7
Declaration
Void SetLeadTime(TimeSpan leadTime)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | leadTime | Time blocked (minutes) BEFORE starttime. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
TimeSpan leadTime;
thing.SetLeadTime(leadTime);SetLinks(NSLink[])
Introduced or updated in version: 7
Declaration
Void SetLinks(NSLink[] links)Parameters
| Type | Name | Description |
|---|---|---|
| NSLink[] | links | List of all elements linked to the appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSLink[] links;
thing.SetLinks(links);SetLocation(String)
Introduced or updated in version: 7
Declaration
Void SetLocation(String location)Parameters
| Type | Name | Description |
|---|---|---|
| String | location | Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
String location;
thing.SetLocation(location);SetMotherAssociate(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetMotherAssociate(NSAssociate motherAssociate)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | motherAssociate | The owner of the mother appointment - the associate whose diary/checklist the mother appointment is in. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
The mother appointment is the one identified by the mother_id. If the mother_id is 0 or the same as this appointment_id, then the master associate will be the same as the 'ordinary' associate.
Examples
NSAppointmentEntity thing;
NSAssociate motherAssociate;
thing.SetMotherAssociate(motherAssociate);SetMotherId(Integer)
Introduced or updated in version: 7
Declaration
Void SetMotherId(Integer motherId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | motherId | ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
If 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking
Examples
NSAppointmentEntity thing;
Integer motherId;
thing.SetMotherId(motherId);SetParticipants(NSParticipantInfo[])
Introduced or updated in version: 7
Declaration
Void SetParticipants(NSParticipantInfo[] participants)Parameters
| Type | Name | Description |
|---|---|---|
| NSParticipantInfo[] | participants | List of IDs of the participants to this appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSParticipantInfo[] participants;
thing.SetParticipants(participants);SetPerson(NSPerson)
Introduced or updated in version: 7
Declaration
Void SetPerson(NSPerson person)Parameters
| Type | Name | Description |
|---|---|---|
| NSPerson | person | An appointment may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSPerson person;
thing.SetPerson(person);SetPreferredTZLocation(Integer)
Introduced or updated in version: 7
Declaration
Void SetPreferredTZLocation(Integer preferredTZLocation)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | preferredTZLocation | Appointment's preferred timezone location. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer preferredTZLocation;
thing.SetPreferredTZLocation(preferredTZLocation);SetPriority(NSPriority)
It's possible to give appointments different priorities. All the different priority types are saved in the priority table, and edited from the Admin Client. An appointment does not require a priority.
Introduced or updated in version: 7
Declaration
Void SetPriority(NSPriority priority)Parameters
| Type | Name | Description |
|---|---|---|
| NSPriority | priority |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSPriority priority;
thing.SetPriority(priority);SetPrivate(Integer)
The confidentiality of appointments is shown as different types of private on the appointment.
Introduced or updated in version: 7
Declaration
Void SetPrivate(Integer private)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | private | See AppointmentPrivate. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer private;
thing.SetPrivate(private);SetProject(NSProject)
Introduced or updated in version: 7
Declaration
Void SetProject(NSProject project)Parameters
| Type | Name | Description |
|---|---|---|
| NSProject | project | An appointment may also be connected to a project, so you see the appointment both on the company card, and on the project card. This does not mean however that a project is required. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSProject project;
thing.SetProject(project);SetPublishEventDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetPublishEventDate(DateTime publishDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | publishDate | Publish event date on NSAppointmentEntity. |
Returns
| Type | Description |
|---|---|
| Void |
SetPublishFrom(DateTime)
Sets the publish from date on an NSAppointmentEntity.
Introduced or updated in version: 7
Declaration
Void SetPublishFrom(DateTime publishFrom)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | publishFrom | Publish event date on NSAppointmentEntity. |
Returns
| Type | Description |
|---|---|
| Void |
SetPublishTo(DateTime)
Sets the publish to date on NSAppointmentEntity.
Introduced or updated in version: 7
Declaration
Void SetPublishTo(DateTime publishTo)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | publishTo | After this date the event is no longer visible. |
Returns
| Type | Description |
|---|---|
| Void |
SetRecurrence(NSRecurrenceInfo)
Introduced or updated in version: 7
Declaration
Void SetRecurrence(NSRecurrenceInfo recurrence)Parameters
| Type | Name | Description |
|---|---|---|
| NSRecurrenceInfo | recurrence | The appointment recurrence. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSRecurrenceInfo recurrence;
thing.SetRecurrence(recurrence);SetRejectCounter(Integer)
Introduced or updated in version: 7
Declaration
Void SetRejectCounter(Integer rejectCounter)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | rejectCounter | How many invitees have rejected this appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer rejectCounter;
thing.SetRejectCounter(rejectCounter);SetRejectReason(String)
Introduced or updated in version: 7
Declaration
Void SetRejectReason(String rejectReason)Parameters
| Type | Name | Description |
|---|---|---|
| String | rejectReason | Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
String rejectReason;
thing.SetRejectReason(rejectReason);SetSale(NSSale)
Introduced or updated in version: 7
Declaration
Void SetSale(NSSale sale)Parameters
| Type | Name | Description |
|---|---|---|
| NSSale | sale | An appointment may also be connected to a sale, so you see the appointment on the company card, on the project card and on the sale card. This does not mean however that a sale is required. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSSale sale;
thing.SetSale(sale);SetStartDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetStartDate(DateTime startDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | startDate | date + start time planned. |
Examples
NSAppointmentEntity thing;
DateTime startDate;
thing.SetStartDate(startDate);SetSuggestedAppointmentId(Integer)
Introduced or updated in version: 7
Declaration
Void SetSuggestedAppointmentId(Integer suggestedAppointmentId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | suggestedAppointmentId | Suggested guide item that this appointment is an instance of. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
NOT VALID for document-type appointments, they have their own link.
Examples
NSAppointmentEntity thing;
Integer suggestedAppointmentId;
thing.SetSuggestedAppointmentId(suggestedAppointmentId);SetTask(NSTaskListItem)
Introduced or updated in version: 7
Declaration
Void SetTask(NSTaskListItem task)Parameters
| Type | Name | Description |
|---|---|---|
| NSTaskListItem | task | Task comprises the different types of activities, such as Phone or Meeting. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSTaskListItem task;
thing.SetTask(task);SetType(Integer)
Introduced or updated in version: 7
Declaration
Void SetType(Integer type)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | type | The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. See AppointmentType. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
Integer type;
thing.SetType(type);SetUpdatedBy(NSAssociate)
Introduced or updated in version: 7
Declaration
Void SetUpdatedBy(NSAssociate updatedBy)Parameters
| Type | Name | Description |
|---|---|---|
| NSAssociate | updatedBy | The person that last updated the appointment. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);SetUpdatedDate(DateTime)
Introduced or updated in version: 7
Declaration
Void SetUpdatedDate(DateTime updatedDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | updatedDate | Updated date. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);SetUserDefinedFields(Map)
Sets the user-defined fields on the NSAppointmentEntity as a map.
Introduced or updated in version: 7
Declaration
Void SetUserDefinedFields(Map udefs)Parameters
| Type | Name | Description |
|---|---|---|
| Map | udefs |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity 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);SetVisibleFor(NSVisibleFor[])
Sets the usergroups and/or users the NSAppointmentEntity item is visible for.
Introduced or updated in version: 7
Declaration
Void SetVisibleFor(NSVisibleFor[] visibleFor)Parameters
| Type | Name | Description |
|---|---|---|
| NSVisibleFor[] | visibleFor |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSAppointmentEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();
visibleFor[0].SetVisiblity(1); // usergroup
visibleFor[0].SetVisibleId(123); // usergroup id
thing.SetVisibleFor(visibleFor);