Skip to main content
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.

Methods

GetActiveDate()

Returns: CRMScript.Global.DateTime - The date to be used for searching and showing. Example:
Returns: CRMScript.Global.Integer - Number of active links to sale, document, appointment. Example:

GetAlarmLeadTime()

Returns: CRMScript.Native.TimeSpan - Alarm lead time. Example:

GetAlldayEvent()

Returns: CRMScript.Global.Bool - True if this is an all day event.

GetAppointmentId()

Returns: CRMScript.Global.Integer - Primary key. Example:

GetAssignedBy()

Returns: CRMScript.NetServer.NSAssociate - Who assigned this appointment to this user? Whose diary did the appointment come from? Example:

GetAssignmentStatus()

Returns: CRMScript.Global.Integer - Status if this appointment is in the process of being assigned to someone else. Example:

GetAssociate()

Returns: CRMScript.NetServer.NSAssociate - The owner of the appointment - the associate whose diary/checklist the appointment is in. Example:

GetAgenda()

Returns: CRMScript.Global.String - Agenda for the appointment. Example:

GetBookingType()

Returns: CRMScript.Global.Integer - The type of booking the appointment represents. Example:

GetCautionWarning()

Returns: CRMScript.Global.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> Example:

GetCentralserviceVideomeetId()

Returns: CRMScript.Global.String - 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.
Example:

GetColorIndex()

Returns: CRMScript.Global.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>. Example:

GetCompleted()

Returns: CRMScript.Global.Integer - Appointment Completed state.
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.
Example:

GetContact()

Returns: CRMScript.NetServer.NSContact - The contact associated with the appointment. It may also be null if no contact is associated with the appointment. Example:

GetCreatedBy()

Returns: CRMScript.NetServer.NSAssociate - The associate that first created the appointment.
The property is read-only.
Example:

GetCreatedDate()

Returns: CRMScript.Global.DateTime - Registered date. Example:

GetCustomFields()

Gets the user-defined + extra fields on an NSAppointmentEntity as a map.
Returns: CRMScript.Native.Map - Map containing user defined and extra field values by field name. Example:

GetDescription()

Returns: CRMScript.Global.String - Description of the appointment. Example:

GetEndDate()

Returns: CRMScript.Global.DateTime - Date + end time planned. Example:

GetExtraFields()

Gets the extra fields on NSAppointmentEntity as a map.
Returns: CRMScript.Native.Map - Map containing extra field values by field name. Example:

GetFreeBusy()

Returns: CRMScript.Global.Bool - What kind of time is this? False is Busy. True is Free.

GetHasAlarm()

Returns: CRMScript.Global.Bool - Does this appointment have an alarm? Example:

GetHasConflict()

Returns: CRMScript.Global.Bool - Does the appointment overlap with another appointment in the user’s diary? Example:

GetInternalNotes()

Returns: CRMScript.Global.String - Internal notes for the appointment. Example:

GetInvitationStatus()

Returns: CRMScript.Global.Integer - Status if this appointment represents an invitation. Example:

GetInvitedPerson()

Returns: CRMScript.NetServer.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. Example:

GetIsAlldayEvent()

Returns: CRMScript.Global.Bool - True if all day event. Example:

GetIsFree()

Returns: CRMScript.Global.Bool - True if free, false if busy. Example:

GetIsMileStone()

Returns: CRMScript.Global.Bool - Is this appointment a milestone? Example:

GetIsPublished()

Returns: CRMScript.Global.Bool - Should this NSAppointmentEntity be published and visible to strangers?

GetJoinVideomeetUrl()

Returns: CRMScript.Global.String - Blank when not a video meeting. Filled with Join Meeting URL when created. Example:

GetLagTime()

Returns: CRMScript.Native.TimeSpan - As leadtime, but after the end - time blocked for travel and so on. Example:

GetLeadTime()

Returns: CRMScript.Native.TimeSpan - Time blocked (minutes) BEFORE starttime. Example:
Returns: CRMScript.NetServer.NSLink[] - List of all elements linked to the appointment. Example:

GetLocation()

Returns: CRMScript.Global.String - Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here. Example:

GetMotherAssociate()

Returns: CRMScript.NetServer.NSAssociate - The owner of the mother appointment - the associate whose diary/checklist the mother appointment is in.
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.
Example:

GetMotherId()

Returns: CRMScript.Global.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. Example:

GetParticipants()

Returns: CRMScript.NetServer.NSParticipantInfo[] - List of IDs of the participants to this appointment. Example:

GetPerson()

Returns: CRMScript.NetServer.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. Example:

GetPreferredTZLocation()

Returns: CRMScript.Global.Integer - Appointment’s preferred timezone location. Example:

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.
Returns: CRMScript.NetServer.NSPriority Example:

GetPrivate()

Returns: CRMScript.Global.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> Example:

GetProject()

Returns: CRMScript.NetServer.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. Example:

GetPublishEventDate()

Returns: CRMScript.Global.DateTime - Publish event date on NSAppointmentEntity.

GetPublishFrom()

Returns: CRMScript.Global.DateTime - Publish from date on NSAppointmentEntity.

GetPublishTo()

Returns: CRMScript.Global.DateTime - Publish to date on NSAppointmentEntity. After this date the event is no longer visible.

GetRecurrence()

Returns: CRMScript.NetServer.NSRecurrenceInfo - The appointment recurrence. Example:

GetRejectCounter()

Returns: CRMScript.Global.Integer - How many invitees have rejected this appointment? Example:

GetRejectReason()

Returns: CRMScript.Global.String - Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here. Example:

GetSale()

Returns: CRMScript.NetServer.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. Example:

GetStartDate()

Returns: CRMScript.Global.DateTime - date + start time planned. Example:

GetSuggestedAppointmentId()

Returns: CRMScript.Global.Integer - Suggested guide item that this appointment is an instance of
NOT VALID for document-type appointments, they have their own link
Example:

GetTitle()

Returns: CRMScript.Global.String - Title for the appointment. Example:

GetTask()

Returns: CRMScript.NetServer.NSTaskListItem - Task comprises the different types of activities, such as Phone call or Meeting. Example:

GetType()

Returns: CRMScript.Global.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. Example:

GetUpdatedBy()

Returns: CRMScript.NetServer.NSAssociate - The person that last updated the appointment. Example:

GetUpdatedDate()

Returns: CRMScript.Global.DateTime - Updated date. Example:

GetUserDefinedFields()

Gets the user-defined fields on the NSAppointmentEntity as a map.
Returns: CRMScript.Native.Map - Map containing user defined field values by field prog.id. Example:

GetVisibleFor()

Returns the usergroups and/or users the NSAppointmentEntity item is visible for.
Returns: CRMScript.NetServer.NSVisibleFor[] - Visible for array. Example:

SetActiveDate(DateTime)

Returns: CRMScript.Global.Void Example:
Returns: CRMScript.Global.Void Example:

SetAlarmLeadTime(TimeSpan)

Returns: CRMScript.Global.Void Example:

SetAlldayEvent(Bool)

Returns: CRMScript.Global.Void

SetAppointmentId(Integer)

Returns: CRMScript.Global.Void Example:

SetAssignedBy(NSAssociate)

Returns: CRMScript.Global.Void Example:

SetAssignmentStatus(Integer)

Returns: CRMScript.Global.Void Example:

SetAgenda(String)

Returns: CRMScript.Global.Void Example:

SetAssociate(NSAssociate)

Returns: CRMScript.Global.Void Example:

SetBookingType(Integer)

Returns: CRMScript.Global.Void Example:

SetCautionWarning(Integer)

Returns: CRMScript.Global.Void Example:

SetCentralserviceVideomeetId(String)

Returns: CRMScript.Global.Void Example:

SetColorIndex(Integer)

Returns: CRMScript.Global.Void Example:

SetCompleted(Integer)

Returns: CRMScript.Global.Void
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.
Example:

SetContact(NSContact)

Returns: CRMScript.Global.Void Example:

SetCreatedBy(NSAssociate)

Returns: CRMScript.Global.Void
The property is read-only.
Example:

SetCreatedDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetCustomFields(Map)

Sets the user-defined and extra fields on an NSAppointmentEntity with a map.
Returns: CRMScript.Global.Void Example:

SetDescription(String)

Returns: CRMScript.Global.Void Example:

SetEndDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetExtraFields(Map)

Sets the extra field values on NSAppointmentEntity with a map.
Returns: CRMScript.Global.Void Example:

SetFreeBusy(Bool)

Returns: CRMScript.Global.Void

SetHasAlarm(Bool)

Returns: CRMScript.Global.Void Example:

SetHasConflict(Bool)

Returns: CRMScript.Global.Void Example:

SetInternalNotes(String)

Returns: CRMScript.Global.Void Example:

SetInvitationStatus(Integer)

Returns: CRMScript.Global.Void Example:

SetInvitedPerson(NSPerson)

Returns: CRMScript.Global.Void Example:

SetIsAlldayEvent(Bool)

Returns: CRMScript.Global.Void Example:

SetIsFree(Bool)

Returns: CRMScript.Global.Void Example:

SetIsMileStone(Bool)

Returns: CRMScript.Global.Void Example:

SetIsPublished(Bool)

Sets the isPublished property of the appointment.
Returns: CRMScript.Global.Void

SetJoinVideomeetUrl(String)

Returns: CRMScript.Global.Void Example:

SetLagTime(TimeSpan)

Returns: CRMScript.Global.Void Example:

SetLeadTime(TimeSpan)

Returns: CRMScript.Global.Void Example:
Returns: CRMScript.Global.Void Example:

SetLocation(String)

Returns: CRMScript.Global.Void Example:

SetMotherAssociate(NSAssociate)

Returns: CRMScript.Global.Void
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.
Example:

SetMotherId(Integer)

Returns: CRMScript.Global.Void
If 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking
Example:

SetParticipants(NSParticipantInfo[])

Returns: CRMScript.Global.Void Example:

SetPerson(NSPerson)

Returns: CRMScript.Global.Void Example:

SetPreferredTZLocation(Integer)

Returns: CRMScript.Global.Void Example:

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.
Returns: CRMScript.Global.Void Example:

SetPrivate(Integer)

The confidentiality of appointments is shown as different types of private on the appointment.
Returns: CRMScript.Global.Void Example:

SetProject(NSProject)

Returns: CRMScript.Global.Void Example:

SetPublishEventDate(DateTime)

Returns: CRMScript.Global.Void

SetPublishFrom(DateTime)

Sets the publish from date on an NSAppointmentEntity.
Returns: CRMScript.Global.Void

SetPublishTo(DateTime)

Sets the publish to date on NSAppointmentEntity.
Returns: CRMScript.Global.Void

SetRecurrence(NSRecurrenceInfo)

Returns: CRMScript.Global.Void Example:

SetRejectCounter(Integer)

Returns: CRMScript.Global.Void Example:

SetRejectReason(String)

Returns: CRMScript.Global.Void Example:

SetSale(NSSale)

Returns: CRMScript.Global.Void Example:

SetStartDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetSuggestedAppointmentId(Integer)

Returns: CRMScript.Global.Void
NOT VALID for document-type appointments, they have their own link.
Example:

SetTitle(String)

Returns: CRMScript.Global.Void Example:

SetTask(NSTaskListItem)

Returns: CRMScript.Global.Void Example:

SetType(Integer)

Returns: CRMScript.Global.Void Example:

SetUpdatedBy(NSAssociate)

Returns: CRMScript.Global.Void Example:

SetUpdatedDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetUserDefinedFields(Map)

Sets the user-defined fields on the NSAppointmentEntity as a map.
Returns: CRMScript.Global.Void Example:

SetVisibleFor(NSVisibleFor[])

Sets the usergroups and/or users the NSAppointmentEntity item is visible for.
Returns: CRMScript.Global.Void Example:

Related topics

NSAppointmentAgent