Skip to main content
Simple read-only appointment data.

Constructors

NSAppointment()

Initializes a new instance of the NSAppointment class.

Methods

GetActiveDate()

Returns: CRMScript.Global.DateTime - The date to be used for searching and showing. Example:

GetAlarmLeadTime()

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

GetAlldayEvent()

Returns: CRMScript.Global.Integer - Is this an all day event? 0 = No, 1 = Yes.

GetAppointmentId()

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

GetAssignedBy()

Returns: CRMScript.Global.Integer - Who (last) assigned this appointment to associate_id? Example:

GetAssignedByFullName()

Returns: CRMScript.Global.String - The associate’s culture formatted fullname (firstname, middleName and lastname). Example:

GetAssignmentStatus()

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

GetAssociateFullName()

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

GetAssociateId()

Returns: CRMScript.Global.Integer - ID of associate whose diary the appointment is in, REQUIREd. Example:

GetAssociateName()

Returns: CRMScript.Global.String - The associate’s name. 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:

GetColorIndex()

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

GetContactId()

Returns: CRMScript.Global.Integer - Contact ID of owning contact, may be 0 Example:

GetContactName()

Returns: CRMScript.Global.String - The contact associated with the appointment. Example:

GetCreatedBy()

Returns: CRMScript.Global.String - Who created the appointment. Associate name. Example:

GetCreatedByAssociateId()

Returns: CRMScript.Global.Integer - ID of the associate that created the appointment. Example:

GetCreatedByFullName()

Returns: CRMScript.Global.String - Who created the appointment. Full name. Example:

GetCreatedDate()

Returns: CRMScript.Global.DateTime - Appointment creation date. Example:

GetDescription()

Returns: CRMScript.Global.String - The appointment’s textbox; holds a descriptive text about the appointment. Filled out by the user. Example:

GetEndDate()

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

GetFreeBusy()

Returns: CRMScript.Global.Integer - What kind of time is this? 0 = Busy, 1 = Free.

GetHasAlarm()

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

GetInvitationStatus()

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

GetIsAlldayEvent()

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

GetIsBooking()

Returns: CRMScript.Global.Bool - True if this appointment is a booking. Example:

GetIsBookingMain()

Returns: CRMScript.Global.Bool - True if this appointment is a booking and current associate is the owner; False if it is a booking and current associate is a participant. Example:

GetIsFree()

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

GetIsPublished()

Returns: CRMScript.Global.Bool - True if appointment have an entry in published table. Example:

GetIsRecurrence()

Returns: CRMScript.Global.Bool - True if the appointment is part of a recurring pattern. Example:

GetJoinVideomeetUrl()

Returns: CRMScript.Global.String - Blank when not a video meeting. Filled with Join Meeting URL when created. 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:

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:

GetPersonFullName()

Returns: CRMScript.Global.String - The full name of the person this appointment belongs to. Example:

GetPersonId()

Returns: CRMScript.Global.Integer - Person ID of person the appointment is with, may be 0 Example:

GetPriorityId()

Returns: CRMScript.Global.Integer - Link to priority list. Example:

GetPriorityName()

Returns: CRMScript.Global.String - Name of the appointments priority. Example:

GetPrivate()

Returns: CRMScript.NetServer.AppointmentPrivate - De-normalization of visibleFor status. See <xref href=“CRMScript.NetServer.AppointmentPrivate” data-throw-if-not-resolved=“false”></xref>
Obsolete, but still maintained field for appointment privacy.
Example:

GetProjectId()

Returns: CRMScript.Global.Integer - ID of project referred to, may be 0 Example:

GetProjectName()

Returns: CRMScript.Global.String - The name of the project this appointment belong to. Blank if no project is connected. Example:

GetRecurringEndDate()

Returns: CRMScript.Global.DateTime Example:

GetRecurringPattern()

Returns: CRMScript.Global.Integer - See <xref href=“CRMScript.NetServer.RecurrencePattern” data-throw-if-not-resolved=“false”></xref> Example:

GetRecurringStartDate()

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

GetSaleId()

Returns: CRMScript.Global.Integer - Owning sale, if any (may be 0). Example:

GetSaleName()

Returns: CRMScript.Global.String - Heading of Owning sale, if any. (may be blank). Example:

GetStartDate()

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

GetTask()

Returns: CRMScript.Global.String
Task comprises the different types of activities, like “Phone call”, “Meeting” and so on.
Example:

GetTaskType()

Returns: CRMScript.Global.Integer - The different task types of the appointment, if the activity is an appointment, task, phone. See <xref href=“CRMScript.NetServer.TaskType” data-throw-if-not-resolved=“false”></xref> 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.
See the different types of appointments in the database manual.
Example:

SetActiveDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetAlarmLeadTime(TimeSpan)

Returns: CRMScript.Global.Void Example:

SetAlldayEvent(Integer)

Returns: CRMScript.Global.Void

SetAppointmentId(Integer)

Returns: CRMScript.Global.Void Example:

SetAssignedBy(Integer)

Returns: CRMScript.Global.Void Example:

SetAssignedByFullName(String)

Returns: CRMScript.Global.Void Example:

SetAssignmentStatus(Integer)

Returns: CRMScript.Global.Void Example:

SetAssociateFullName(String)

Returns: CRMScript.Global.Void Example:

SetAssociateId(Integer)

Returns: CRMScript.Global.Void Example:

SetAssociateName(String)

Returns: CRMScript.Global.Void Example:

SetBookingType(Integer)

Returns: CRMScript.Global.Void Example:

SetCautionWarning(Integer)

Returns: CRMScript.Global.Void Example:

SetColorIndex(Integer)

Returns: CRMScript.Global.Void Example:

SetCompleted(Integer)

Returns: CRMScript.Global.Void Example:

SetContactId(Integer)

Returns: CRMScript.Global.Void Example:

SetContactName(String)

Returns: CRMScript.Global.Void Example:

SetCreatedBy(String)

Returns: CRMScript.Global.Void Example:

SetCreatedByAssociateId(Integer)

Returns: CRMScript.Global.Void Example:

SetCreatedByFullName(String)

Returns: CRMScript.Global.Void Example:

SetCreatedDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetDescription(String)

Returns: CRMScript.Global.Void Example:

SetEndDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetFreeBusy(Integer)

Returns: CRMScript.Global.Void

SetHasAlarm(Bool)

Returns: CRMScript.Global.Void Example:

SetInvitationStatus(Integer)

Returns: CRMScript.Global.Void Example:

SetIsAlldayEvent(Bool)

Returns: CRMScript.Global.Void Example:

SetIsBooking(Bool)

Returns: CRMScript.Global.Void Example:

SetIsBookingMain(Bool)

Returns: CRMScript.Global.Void Example:

SetIsFree(Bool)

Returns: CRMScript.Global.Void Example:

SetIsPublished(Bool)

Returns: CRMScript.Global.Void Example:

SetIsRecurrence(Bool)

Returns: CRMScript.Global.Void Example:

SetJoinVideomeetUrl(String)

Returns: CRMScript.Global.Void Example:

SetLocation(String)

Returns: CRMScript.Global.Void Example:

SetMotherId(Integer)

Returns: CRMScript.Global.Void Example:

SetPersonFullName(String)

Returns: CRMScript.Global.Void Example:

SetPersonId(Integer)

Returns: CRMScript.Global.Void Example:

SetPriorityId(Integer)

Returns: CRMScript.Global.Void Example:

SetPriorityName(String)

Returns: CRMScript.Global.Void Example:

SetPrivate(Integer)

Obsolete, but still maintained field for appointment privacy.
Returns: CRMScript.Global.Void Example:

SetProjectId(Integer)

Returns: CRMScript.Global.Void Example:

SetProjectName(String)

Returns: CRMScript.Global.Void Example:

SetRecurringEndDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetRecurringPattern(Integer)

Returns: CRMScript.Global.Void Example:

SetRecurringStartDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetRejectReason(String)

Returns: CRMScript.Global.Void Example:

SetSaleId(Integer)

Returns: CRMScript.Global.Void Example:

SetSaleName(String)

Returns: CRMScript.Global.Void Example:

SetStartDate(DateTime)

Returns: CRMScript.Global.Void Example:

SetTask(String)

Returns: CRMScript.Global.Void Example:

SetTaskType(Integer)

Returns: CRMScript.Global.Void Example:

SetType(Integer)

Returns: CRMScript.Global.Void Example: