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.
Constructors
NSAppointmentEntity()
Initializes a new instance of the NSAppointmentEntity class.
Declaration
NSAppointmentEntityMethods
GetActiveDate()
Declaration
DateTime GetActiveDate()Examples
NSAppointmentEntity thing;
DateTime activeDate = thing.GetActiveDate();Returns
| Type | Description |
| DateTime | The date to be used for searching and showing. |
GetActiveLinks()
Declaration
Integer GetActiveLinks()Examples
NSAppointmentEntity thing;
Integer activeLinks = thing.GetActiveLinks();Returns
| Type | Description |
| Integer | Number of active links to sale, document, appointment. |
GetAlarmLeadTime()
Declaration
TimeSpan GetAlarmLeadTime()Examples
NSAppointmentEntity thing;
TimeSpan alarmLeadTime = thing.GetAlarmLeadTime();Returns
| Type | Description |
| TimeSpan | Alarm lead time. |
GetAlldayEvent()
Declaration
Bool GetAlldayEvent()Returns
| Type | Description |
| Bool | True if this is an all day event. |
GetAppointmentId()
Declaration
Integer GetAppointmentId()Examples
NSAppointmentEntity thing;
Integer appointmentId = thing.GetAppointmentId();Returns
| Type | Description |
| Integer | Primary key. |
GetAssignedBy()
Declaration
NSAssociate GetAssignedBy()Examples
NSAppointmentEntity thing;
NSAssociate assignedBy = thing.GetAssignedBy();Returns
| Type | Description |
| NSAssociate | Who assigned this appointment to this user? Whose diary did the appointment come from? |
GetAssignmentStatus()
Declaration
Integer GetAssignmentStatus()Examples
NSAppointmentEntity thing;
Integer assignmentStatus = thing.GetAssignmentStatus();Returns
| Type | Description |
| Integer | Status if this appointment is in the process of being assigned to someone else. |
GetAssociate()
Declaration
NSAssociate GetAssociate()Examples
NSAppointmentEntity thing;
NSAssociate associate = thing.GetAssociate();Returns
| Type | Description |
| NSAssociate | The owner of the appointment - the associate whose diary/checklist the appointment is in. |
GetAgenda()
Declaration
String GetAgenda()Examples
NSAppointmentEntity thing;
String agenda = thing.GetAgenda();Returns
| Type | Description |
| String | Agenda for the appointment. |
GetBookingType()
Declaration
Integer GetBookingType()Examples
NSAppointmentEntity thing;
Integer bookingType = thing.GetBookingType();Returns
| Type | Description |
| Integer | The type of booking the appointment represents. |
GetCautionWarning()
Declaration
Integer GetCautionWarning()Examples
NSAppointmentEntity thing;
Integer cautionWarning = thing.GetCautionWarning();Returns
| Type | Description |
| Integer | Status field to indicate appointments that have some sort of problem. See <xref href="CRMScript.NetServer.AppointmentCautionWarning" data-throw-if-not-resolved="false"></xref> |
GetCentralserviceVideomeetId()
Declaration
String GetCentralserviceVideomeetId()Examples
NSAppointmentEntity thing;
String centralserviceVideomeetId = thing.GetCentralserviceVideomeetId();Returns
| Type | Description |
| String | GUID for video meeting in central services. |
GetColorIndex()
Declaration
Integer GetColorIndex()Examples
NSAppointmentEntity thing;
Integer colorIndex = thing.GetColorIndex();Returns
| Type | Description |
| Integer | Appointment colour, used only in Japanese versions. Western versions take colour from Task. See <xref href="CRMScript.NetServer.ColorIndex" data-throw-if-not-resolved="false"></xref>. |
GetCompleted()
Declaration
Integer GetCompleted()Examples
NSAppointmentEntity thing;
Integer completed = thing.GetCompleted();Returns
| Type | Description |
| Integer | Appointment Completed state. |
GetContact()
Declaration
NSContact GetContact()Examples
NSAppointmentEntity thing;
NSContact contact = thing.GetContact();Returns
| Type | Description |
| NSContact | The contact associated with the appointment. It may also be null if no contact is associated with the appointment. |
GetCreatedBy()
Declaration
NSAssociate GetCreatedBy()Examples
NSAppointmentEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();Returns
| Type | Description |
| NSAssociate | The associate that first created the appointment. |
GetCreatedDate()
Declaration
DateTime GetCreatedDate()Examples
NSAppointmentEntity thing;
DateTime createdDate = thing.GetCreatedDate();Returns
| Type | Description |
| DateTime | Registered date. |
GetCustomFields()
Gets the user-defined + extra fields on an NSAppointmentEntity as a map.
Declaration
Map GetCustomFields()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());Returns
| Type | Description |
| Map | Map containing user defined and extra field values by field name. |
GetDescription()
Declaration
String GetDescription()Examples
NSAppointmentEntity thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | Description of the appointment. |
GetEndDate()
Declaration
DateTime GetEndDate()Examples
NSAppointmentEntity thing;
DateTime endDate = thing.GetEndDate();Returns
| Type | Description |
| DateTime | Date + end time planned. |
GetExtraFields()
Gets the extra fields on NSAppointmentEntity as a map.
Declaration
Map GetExtraFields()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());Returns
| Type | Description |
| Map | Map containing extra field values by field name. |
GetFreeBusy()
Declaration
Bool GetFreeBusy()Returns
| Type | Description |
| Bool | What kind of time is this? False is Busy. True is Free. |
GetHasAlarm()
Declaration
Bool GetHasAlarm()Examples
NSAppointmentEntity thing;
Bool hasAlarm = thing.GetHasAlarm();Returns
| Type | Description |
| Bool | Does this appointment have an alarm? |
GetHasConflict()
Declaration
Bool GetHasConflict()Examples
NSAppointmentEntity thing;
Bool hasConflict = thing.GetHasConflict();Returns
| Type | Description |
| Bool | Does the appointment overlap with another appointment in the user's diary? |
GetInternalNotes()
Declaration
String GetInternalNotes()Examples
NSAppointmentEntity thing;
String notes = thing.GetInternalNotes();Returns
| Type | Description |
| String | Internal notes for the appointment. |
GetInvitationStatus()
Declaration
Integer GetInvitationStatus()Examples
NSAppointmentEntity thing;
Integer invitationStatus = thing.GetInvitationStatus();Returns
| Type | Description |
| Integer | Status if this appointment represents an invitation. |
GetInvitedPerson()
Declaration
NSPerson GetInvitedPerson()Examples
NSAppointmentEntity thing;
NSPerson invitedPerson = thing.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. |
GetIsAlldayEvent()
Declaration
Bool GetIsAlldayEvent()Examples
NSAppointmentEntity thing;
Bool isAlldayEvent = thing.GetIsAlldayEvent();Returns
| Type | Description |
| Bool | True if all day event. |
GetIsFree()
Declaration
Bool GetIsFree()Examples
NSAppointmentEntity thing;
Bool isFree = thing.GetIsFree();Returns
| Type | Description |
| Bool | True if free, false if busy. |
GetIsMileStone()
Declaration
Bool GetIsMileStone()Examples
NSAppointmentEntity thing;
Bool isMileStone = thing.GetIsMileStone();Returns
| Type | Description |
| Bool | Is this appointment a milestone? |
GetIsPublished()
Declaration
Bool GetIsPublished()Returns
| Type | Description |
| Bool | Should this NSAppointmentEntity be published and visible to strangers? |
GetJoinVideomeetUrl()
Declaration
String GetJoinVideomeetUrl()Examples
NSAppointmentEntity thing;
String joinVideomeetUrl = thing.GetJoinVideomeetUrl();Returns
| Type | Description |
| String | Blank when not a video meeting. Filled with Join Meeting URL when created. |
GetLagTime()
Declaration
TimeSpan GetLagTime()Examples
NSAppointmentEntity thing;
TimeSpan lagTime = thing.GetLagTime();Returns
| Type | Description |
| TimeSpan | As leadtime, but after the end - time blocked for travel and so on. |
GetLeadTime()
Declaration
TimeSpan GetLeadTime()Examples
NSAppointmentEntity thing;
TimeSpan leadTime = thing.GetLeadTime();Returns
| Type | Description |
| TimeSpan | Time blocked (minutes) BEFORE starttime. |
GetLinks()
Declaration
NSLink[] GetLinks()Examples
NSAppointmentEntity thing;
NSLink[] links = thing.GetLinks();Returns
| Type | Description |
| NSLink[] | List of all elements linked to the appointment. |
GetLocation()
Declaration
String GetLocation()Examples
NSAppointmentEntity thing;
String location = thing.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. |
GetMotherAssociate()
Declaration
NSAssociate GetMotherAssociate()Examples
NSAppointmentEntity thing;
NSAssociate motherAssociate = thing.GetMotherAssociate();Returns
| Type | Description |
| NSAssociate | The owner of the mother appointment - the associate whose diary/checklist the mother appointment is in. |
GetMotherId()
Declaration
Integer GetMotherId()Examples
NSAppointmentEntity thing;
Integer motherId = thing.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. |
GetParticipants()
Declaration
NSParticipantInfo[] GetParticipants()Examples
NSAppointmentEntity thing;
NSParticipantInfo[] participants = thing.GetParticipants();Returns
| Type | Description |
| NSParticipantInfo[] | List of IDs of the participants to this appointment. |
GetPerson()
Declaration
NSPerson GetPerson()Examples
NSAppointmentEntity thing;
NSPerson person = thing.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. |
GetPreferredTZLocation()
Declaration
Integer GetPreferredTZLocation()Examples
NSAppointmentEntity thing;
Integer preferredTZLocation = thing.GetPreferredTZLocation();Returns
| Type | Description |
| Integer | Appointment's preferred timezone location. |
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.
Declaration
NSPriority GetPriority()Examples
NSAppointmentEntity thing;
NSPriority priority = thing.GetPriority();Returns
| Type | Description |
| NSPriority |
GetPrivate()
Declaration
Integer GetPrivate()Examples
NSAppointmentEntity thing;
Integer private = thing.GetPrivate();Returns
| Type | Description |
| Integer | The confidentiality of appointments is shown as different types of private on the appointment. See <xref href="CRMScript.NetServer.AppointmentPrivate" data-throw-if-not-resolved="false"></xref> |
GetProject()
Declaration
NSProject GetProject()Examples
NSAppointmentEntity thing;
NSProject project = thing.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. |
GetPublishEventDate()
Declaration
DateTime GetPublishEventDate()Returns
| Type | Description |
| DateTime | Publish event date on NSAppointmentEntity. |
GetPublishFrom()
Declaration
DateTime GetPublishFrom()Returns
| Type | Description |
| DateTime | Publish from date on NSAppointmentEntity. |
GetPublishTo()
Declaration
DateTime GetPublishTo()Returns
| Type | Description |
| DateTime | Publish to date on NSAppointmentEntity. After this date the event is no longer visible. |
GetRecurrence()
Declaration
NSRecurrenceInfo GetRecurrence()Examples
NSAppointmentEntity thing;
NSRecurrenceInfo recurrence = thing.GetRecurrence();Returns
| Type | Description |
| NSRecurrenceInfo | The appointment recurrence. |
GetRejectCounter()
Declaration
Integer GetRejectCounter()Examples
NSAppointmentEntity thing;
Integer rejectCounter = thing.GetRejectCounter();Returns
| Type | Description |
| Integer | How many invitees have rejected this appointment? |
GetRejectReason()
Declaration
String GetRejectReason()Examples
NSAppointmentEntity thing;
String rejectReason = thing.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. |
GetSale()
Declaration
NSSale GetSale()Examples
NSAppointmentEntity thing;
NSSale sale = thing.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. |
GetStartDate()
Declaration
DateTime GetStartDate()Examples
NSAppointmentEntity thing;
DateTime startDate = thing.GetStartDate();Returns
| Type | Description |
| DateTime | date + start time planned. |
GetSuggestedAppointmentId()
Declaration
Integer GetSuggestedAppointmentId()Examples
NSAppointmentEntity thing;
Integer suggestedAppointmentId = thing.GetSuggestedAppointmentId();Returns
| Type | Description |
| Integer | Suggested guide item that this appointment is an instance of |
GetTitle()
Declaration
String GetTitle()Examples
NSAppointmentEntity thing;
String title = thing.GetTitle();Returns
| Type | Description |
| String | Title for the appointment. |
GetTask()
Declaration
NSTaskListItem GetTask()Examples
NSAppointmentEntity thing;
NSTaskListItem task = thing.GetTask();Returns
| Type | Description |
| NSTaskListItem | Task comprises the different types of activities, such as Phone call or Meeting. |
GetType()
Declaration
Integer GetType()Examples
NSAppointmentEntity thing;
Integer type = thing.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. |
GetUpdatedBy()
Declaration
NSAssociate GetUpdatedBy()Examples
NSAppointmentEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();Returns
| Type | Description |
| NSAssociate | The person that last updated the appointment. |
GetUpdatedDate()
Declaration
DateTime GetUpdatedDate()Examples
NSAppointmentEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();Returns
| Type | Description |
| DateTime | Updated date. |
GetUserDefinedFields()
Gets the user-defined fields on the NSAppointmentEntity as a map.
Declaration
Map GetUserDefinedFields()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());Returns
| Type | Description |
| Map | Map containing user defined field values by field prog.id. |
GetVisibleFor()
Returns the usergroups and/or users the NSAppointmentEntity item is visible for.
Declaration
NSVisibleFor[] GetVisibleFor()Examples
NSAppointmentEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();Returns
| Type | Description |
| NSVisibleFor[] | Visible for array. |
SetActiveDate(DateTime)
Declaration
Void SetActiveDate(DateTime activeDate)Examples
NSAppointmentEntity thing;
DateTime activeDate;
thing.SetActiveDate(activeDate);Parameters
| Type | Name | Description |
| DateTime | activeDate | The date to be used for searching and showing. |
Returns
| Type | Description |
| Void |
SetActiveLinks(Integer)
Declaration
Void SetActiveLinks(Integer activeLinks)Examples
NSAppointmentEntity thing;
Integer activeLinks;
thing.SetActiveLinks(activeLinks);Parameters
| Type | Name | Description |
| Integer | activeLinks | Number of active links to sale, document, appointment. |
Returns
| Type | Description |
| Void |
SetAlarmLeadTime(TimeSpan)
Declaration
Void SetAlarmLeadTime(TimeSpan alarmLeadTime)Examples
NSAppointmentEntity thing;
TimeSpan alarmLeadTime;
thing.SetAlarmLeadTime(alarmLeadTime);Parameters
| Type | Name | Description |
| TimeSpan | alarmLeadTime | Alarm lead time. |
Returns
| Type | Description |
| Void |
SetAlldayEvent(Bool)
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)
Declaration
Void SetAppointmentId(Integer appointmentId)Examples
NSAppointmentEntity thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);Parameters
| Type | Name | Description |
| Integer | appointmentId | Primary key. |
Returns
| Type | Description |
| Void |
SetAssignedBy(NSAssociate)
Declaration
Void SetAssignedBy(NSAssociate assignedBy)Examples
NSAppointmentEntity thing;
NSAssociate assignedBy;
thing.SetAssignedBy(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 |
SetAssignmentStatus(Integer)
Declaration
Void SetAssignmentStatus(Integer assignmentStatus)Examples
NSAppointmentEntity thing;
Integer assignmentStatus;
thing.SetAssignmentStatus(assignmentStatus);Parameters
| Type | Name | Description |
| Integer | assignmentStatus | Status if this appointment is in the process of being assigned to someone else. See <xref href="CRMScript.NetServer.AssignmentStatus" data-throw-if-not-resolved="false"></xref> |
Returns
| Type | Description |
| Void |
SetAgenda(String)
Declaration
Void SetAgenda(String agenda)Examples
NSAppointmentEntity thing;
String agenda;
thing.SetAgenda(agenda);Parameters
| Type | Name | Description |
| String | agenda | Agenda for the appointment |
Returns
| Type | Description |
| Void |
SetAssociate(NSAssociate)
Declaration
Void SetAssociate(NSAssociate associate)Examples
NSAppointmentEntity thing;
NSAssociate associate;
thing.SetAssociate(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 |
SetBookingType(Integer)
Declaration
Void SetBookingType(Integer bookingType)Examples
NSAppointmentEntity thing;
Integer bookingType;
thing.SetBookingType(bookingType);Parameters
| Type | Name | Description |
| Integer | bookingType | The type of booking the appointment represents. See <xref href="CRMScript.NetServer.BookingType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetCautionWarning(Integer)
Declaration
Void SetCautionWarning(Integer cautionWarning)Examples
NSAppointmentEntity thing;
Integer cautionWarning;
thing.SetCautionWarning(cautionWarning);Parameters
| Type | Name | Description |
| Integer | cautionWarning | Status field to indicate appointments that have some sort of problem. See <xref href="CRMScript.NetServer.AppointmentCautionWarning" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetCentralserviceVideomeetId(String)
Declaration
Void SetCentralserviceVideomeetId(String centralserviceVideomeetId)Examples
NSAppointmentEntity thing;
String centralserviceVideomeetId;
thing.SetCentralserviceVideomeetId(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 |
SetColorIndex(Integer)
Declaration
Void SetColorIndex(Integer colorIndex)Examples
NSAppointmentEntity thing;
Integer colorIndex;
thing.SetColorIndex(colorIndex);Parameters
| Type | Name | Description |
| Integer | colorIndex | Appointment colour, used only in Japanese versions. Western versions take colour from Task. See <xref href="CRMScript.NetServer.ColorIndex" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetCompleted(Integer)
Declaration
Void SetCompleted(Integer completed)Examples
NSAppointmentEntity thing;
Integer completed;
thing.SetCompleted(completed);Parameters
| Type | Name | Description |
| Integer | completed | Appointment Completed state. |
Returns
| Type | Description |
| Void |
SetContact(NSContact)
Declaration
Void SetContact(NSContact contact)Examples
NSAppointmentEntity thing;
NSContact contact;
thing.SetContact(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 |
SetCreatedBy(NSAssociate)
Declaration
Void SetCreatedBy(NSAssociate createdBy)Examples
NSAppointmentEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);Parameters
| Type | Name | Description |
| NSAssociate | createdBy | The associate that first created the appointment. |
Returns
| Type | Description |
| Void |
SetCreatedDate(DateTime)
Declaration
Void SetCreatedDate(DateTime createdDate)Examples
NSAppointmentEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);Parameters
| Type | Name | Description |
| DateTime | createdDate | Registered date. |
Returns
| Type | Description |
| Void |
SetCustomFields(Map)
Sets the user-defined and extra fields on an NSAppointmentEntity with a map.
Declaration
Void SetCustomFields(Map udefs)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);Parameters
| Type | Name | Description |
| Map | udefs |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSAppointmentEntity thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | Description of the appointment. |
Returns
| Type | Description |
| Void |
SetEndDate(DateTime)
Declaration
Void SetEndDate(DateTime endDate)Examples
NSAppointmentEntity thing;
DateTime endDate;
thing.SetEndDate(endDate);Parameters
| Type | Name | Description |
| DateTime | endTime | Date + end time planned. |
Returns
| Type | Description |
| Void |
SetExtraFields(Map)
Sets the extra field values on NSAppointmentEntity with a map.
Declaration
Void SetExtraFields(Map extras)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);Parameters
| Type | Name | Description |
| Map | extras |
Returns
| Type | Description |
| Void |
SetFreeBusy(Bool)
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)
Declaration
Void SetHasAlarm(Bool hasAlarm)Examples
NSAppointmentEntity thing;
Bool hasAlarm;
thing.SetHasAlarm(hasAlarm);Parameters
| Type | Name | Description |
| Bool | hasAlarm | Does this appointment have an alarm. |
Returns
| Type | Description |
| Void |
SetHasConflict(Bool)
Declaration
Void SetHasConflict(Bool hasConflict)Examples
NSAppointmentEntity thing;
Bool hasConflict;
thing.SetHasConflict(hasConflict);Parameters
| Type | Name | Description |
| Bool | hasConflict | Does the appointment overlap with another appointment in the user's diary? |
Returns
| Type | Description |
| Void |
SetInternalNotes(String)
Declaration
Void SetInternalNotes(String internalNotes)Examples
NSAppointmentEntity thing;
String notes;
thing.SetInternalNotes(notes);Parameters
| Type | Name | Description |
| String | internalNotes | Internal notes for the appointment |
Returns
| Type | Description |
| Void |
SetInvitationStatus(Integer)
Declaration
Void SetInvitationStatus(Integer invitationStatus)Examples
NSAppointmentEntity thing;
Integer invitationStatus;
thing.SetInvitationStatus(invitationStatus);Parameters
| Type | Name | Description |
| Integer | invitationStatus | Status if this appointment represents an invitation. See <xref href="CRMScript.NetServer.InvitationStatus" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetInvitedPerson(NSPerson)
Declaration
Void SetInvitedPerson(NSPerson invitedPerson)Examples
NSAppointmentEntity thing;
NSPerson invitedPerson;
thing.SetInvitedPerson(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 |
SetIsAlldayEvent(Bool)
Declaration
Void SetIsAlldayEvent(Bool isAlldayEvent)Examples
NSAppointmentEntity thing;
Bool isAlldayEvent;
thing.SetIsAlldayEvent(isAlldayEvent);Parameters
| Type | Name | Description |
| Bool | isAlldayEvent | True if all day event. |
Returns
| Type | Description |
| Void |
SetIsFree(Bool)
Declaration
Void SetIsFree(Bool isFree)Examples
NSAppointmentEntity thing;
Bool isFree;
thing.SetIsFree(isFree);Parameters
| Type | Name | Description |
| Bool | isFree | True if free, false if busy. |
Returns
| Type | Description |
| Void |
SetIsMileStone(Bool)
Declaration
Void SetIsMileStone(Bool isMileStone)Examples
NSAppointmentEntity thing;
Bool isMileStone;
thing.SetIsMileStone(isMileStone);Parameters
| Type | Name | Description |
| Bool | isMileStone | Is this appointment a milestone? |
Returns
| Type | Description |
| Void |
SetIsPublished(Bool)
Sets the isPublished property of the appointment.
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)
Declaration
Void SetJoinVideomeetUrl(String joinVideomeetUrl)Examples
NSAppointmentEntity thing;
String joinVideomeetUrl;
thing.SetJoinVideomeetUrl(joinVideomeetUrl);Parameters
| Type | Name | Description |
| String | joinVideomeetUrl | Blank when not a video meeting. Filled with Join Meeting URL when created. |
Returns
| Type | Description |
| Void |
SetLagTime(TimeSpan)
Declaration
Void SetLagTime(TimeSpan lagTime)Examples
NSAppointmentEntity thing;
TimeSpan lagTime;
thing.SetLagTime(lagTime);Parameters
| Type | Name | Description |
| TimeSpan | lagTime | As leadtime, but after the end - time blocked for travel and so on. |
Returns
| Type | Description |
| Void |
SetLeadTime(TimeSpan)
Declaration
Void SetLeadTime(TimeSpan leadTime)Examples
NSAppointmentEntity thing;
TimeSpan leadTime;
thing.SetLeadTime(leadTime);Parameters
| Type | Name | Description |
| TimeSpan | leadTime | Time blocked (minutes) BEFORE starttime. |
Returns
| Type | Description |
| Void |
SetLinks(NSLink[])
Declaration
Void SetLinks(NSLink[] links)Examples
NSAppointmentEntity thing;
NSLink[] links;
thing.SetLinks(links);Parameters
| Type | Name | Description |
| NSLink[] | links | List of all elements linked to the appointment. |
Returns
| Type | Description |
| Void |
SetLocation(String)
Declaration
Void SetLocation(String location)Examples
NSAppointmentEntity thing;
String location;
thing.SetLocation(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 |
SetMotherAssociate(NSAssociate)
Declaration
Void SetMotherAssociate(NSAssociate motherAssociate)Examples
NSAppointmentEntity thing;
NSAssociate motherAssociate;
thing.SetMotherAssociate(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 |
SetMotherId(Integer)
Declaration
Void SetMotherId(Integer motherId)Examples
NSAppointmentEntity thing;
Integer motherId;
thing.SetMotherId(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 |
SetParticipants(NSParticipantInfo[])
Declaration
Void SetParticipants(NSParticipantInfo[] participants)Examples
NSAppointmentEntity thing;
NSParticipantInfo[] participants;
thing.SetParticipants(participants);Parameters
| Type | Name | Description |
| NSParticipantInfo[] | participants | List of IDs of the participants to this appointment. |
Returns
| Type | Description |
| Void |
SetPerson(NSPerson)
Declaration
Void SetPerson(NSPerson person)Examples
NSAppointmentEntity thing;
NSPerson person;
thing.SetPerson(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 |
SetPreferredTZLocation(Integer)
Declaration
Void SetPreferredTZLocation(Integer preferredTZLocation)Examples
NSAppointmentEntity thing;
Integer preferredTZLocation;
thing.SetPreferredTZLocation(preferredTZLocation);Parameters
| Type | Name | Description |
| Integer | preferredTZLocation | Appointment's preferred timezone location. |
Returns
| Type | Description |
| Void |
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.
Declaration
Void SetPriority(NSPriority priority)Examples
NSAppointmentEntity thing;
NSPriority priority;
thing.SetPriority(priority);Parameters
| Type | Name | Description |
| NSPriority | priority |
Returns
| Type | Description |
| Void |
SetPrivate(Integer)
The confidentiality of appointments is shown as different types of private on the appointment.
Declaration
Void SetPrivate(Integer private)Examples
NSAppointmentEntity thing;
Integer private;
thing.SetPrivate(private);Parameters
| Type | Name | Description |
| Integer | private | See <xref href="CRMScript.NetServer.AppointmentPrivate" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetProject(NSProject)
Declaration
Void SetProject(NSProject project)Examples
NSAppointmentEntity thing;
NSProject project;
thing.SetProject(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 |
SetPublishEventDate(DateTime)
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.
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.
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)
Declaration
Void SetRecurrence(NSRecurrenceInfo recurrence)Examples
NSAppointmentEntity thing;
NSRecurrenceInfo recurrence;
thing.SetRecurrence(recurrence);Parameters
| Type | Name | Description |
| NSRecurrenceInfo | recurrence | The appointment recurrence. |
Returns
| Type | Description |
| Void |
SetRejectCounter(Integer)
Declaration
Void SetRejectCounter(Integer rejectCounter)Examples
NSAppointmentEntity thing;
Integer rejectCounter;
thing.SetRejectCounter(rejectCounter);Parameters
| Type | Name | Description |
| Integer | rejectCounter | How many invitees have rejected this appointment. |
Returns
| Type | Description |
| Void |
SetRejectReason(String)
Declaration
Void SetRejectReason(String rejectReason)Examples
NSAppointmentEntity thing;
String rejectReason;
thing.SetRejectReason(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 |
SetSale(NSSale)
Declaration
Void SetSale(NSSale sale)Examples
NSAppointmentEntity thing;
NSSale sale;
thing.SetSale(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 |
SetStartDate(DateTime)
Declaration
Void SetStartDate(DateTime startDate)Examples
NSAppointmentEntity thing;
DateTime startDate;
thing.SetStartDate(startDate);Parameters
| Type | Name | Description |
| DateTime | startDate | date + start time planned. |
Returns
| Type | Description |
| Void |
SetSuggestedAppointmentId(Integer)
Declaration
Void SetSuggestedAppointmentId(Integer suggestedAppointmentId)Examples
NSAppointmentEntity thing;
Integer suggestedAppointmentId;
thing.SetSuggestedAppointmentId(suggestedAppointmentId);Parameters
| Type | Name | Description |
| Integer | suggestedAppointmentId | Suggested guide item that this appointment is an instance of. |
Returns
| Type | Description |
| Void |
SetTitle(String)
Declaration
Void SetTitle(String agenda)Examples
NSAppointmentEntity thing;
String title;
thing.SetTitle(title);Parameters
| Type | Name | Description |
| String | agenda | Title for the appointment |
Returns
| Type | Description |
| Void |
SetTask(NSTaskListItem)
Declaration
Void SetTask(NSTaskListItem task)Examples
NSAppointmentEntity thing;
NSTaskListItem task;
thing.SetTask(task);Parameters
| Type | Name | Description |
| NSTaskListItem | task | Task comprises the different types of activities, such as Phone or Meeting. |
Returns
| Type | Description |
| Void |
SetType(Integer)
Declaration
Void SetType(Integer type)Examples
NSAppointmentEntity thing;
Integer type;
thing.SetType(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 <xref href="CRMScript.NetServer.AppointmentType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetUpdatedBy(NSAssociate)
Declaration
Void SetUpdatedBy(NSAssociate updatedBy)Examples
NSAppointmentEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);Parameters
| Type | Name | Description |
| NSAssociate | updatedBy | The person that last updated the appointment. |
Returns
| Type | Description |
| Void |
SetUpdatedDate(DateTime)
Declaration
Void SetUpdatedDate(DateTime updatedDate)Examples
NSAppointmentEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);Parameters
| Type | Name | Description |
| DateTime | updatedDate | Updated date. |
Returns
| Type | Description |
| Void |
SetUserDefinedFields(Map)
Sets the user-defined fields on the NSAppointmentEntity as a map.
Declaration
Void SetUserDefinedFields(Map udefs)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);Parameters
| Type | Name | Description |
| Map | udefs |
Returns
| Type | Description |
| Void |
SetVisibleFor(NSVisibleFor[])
Sets the usergroups and/or users the NSAppointmentEntity item is visible for.
Declaration
Void SetVisibleFor(NSVisibleFor[] visibleFor)Examples
NSAppointmentEntity thing;
NSVisibleFor[] visibleFor = thing.GetVisibleFor();
visibleFor[0].SetVisiblity(1); // usergroup
visibleFor[0].SetVisibleId(123); // usergroup id
thing.SetVisibleFor(visibleFor);Parameters
| Type | Name | Description |
| NSVisibleFor[] | visibleFor |
Returns
| Type | Description |
| Void |