Class NSAppointment

Simple read-only appointment data.

Syntax

Constructors

NSAppointment()

Initializes a new instance of the NSAppointment class.

Declaration

NSAppointment

Methods

GetActiveDate()

Simple read-only appointment data.

Declaration

DateTime GetActiveDate()

Returns

Type	Description
DateTime	The date to be used for searching and showing.

Examples

NSAppointment thing;
DateTime activeDate = thing.GetActiveDate();

GetAlarmLeadTime()

Simple read-only appointment data.

Declaration

TimeSpan GetAlarmLeadTime()

Returns

Type	Description
TimeSpan	Alarm lead time.

Examples

NSAppointment thing;
TimeSpan alarmLeadTime = thing.GetAlarmLeadTime();

GetAlldayEvent()

Simple read-only appointment data.

Declaration

Integer GetAlldayEvent()

Returns

Type	Description
Integer	Is this an all day event? 0 = No, 1 = Yes.

GetAppointmentId()

Simple read-only appointment data.

Declaration

Integer GetAppointmentId()

Returns

Type	Description
Integer	Primary key.

Examples

NSAppointment thing;
Integer appointmentId = thing.GetAppointmentId();

GetAssignedBy()

Simple read-only appointment data.

Declaration

Integer GetAssignedBy()

Returns

Type	Description
Integer	Who (last) assigned this appointment to associate_id?

Examples

NSAppointment thing;
Integer assignedBy = thing.GetAssignedBy();

GetAssignedByFullName()

Simple read-only appointment data.

Declaration

String GetAssignedByFullName()

Returns

Type	Description
String	The associate's culture formatted fullname (firstname, middleName and lastname).

Examples

NSAppointment thing;
String assignedByFullName = thing.GetAssignedByFullName();

GetAssignmentStatus()

Simple read-only appointment data.

Declaration

Integer GetAssignmentStatus()

Returns

Type	Description
Integer	Status if this appointment is in the process of being assigned to someone else.

Examples

NSAppointment thing;
Integer assignmentStatus = thing.GetAssignmentStatus();

GetAssociateFullName()

Simple read-only appointment data.

Declaration

String GetAssociateFullName()

Returns

Type	Description
String	The owner of the appointment - the associate whose diary/checklist the appointment is in.

Examples

NSAppointment thing;
String associateFullName = thing.GetAssociateFullName();

GetAssociateId()

Simple read-only appointment data.

Declaration

Integer GetAssociateId()

Returns

Type	Description
Integer	ID of associate whose diary the appointment is in, REQUIREd.

Examples

NSAppointment thing;
Integer associateId = thing.GetAssociateId();

GetAssociateName()

Simple read-only appointment data.

Declaration

String GetAssociateName()

Returns

Type	Description
String	The associate's name.

Examples

NSAppointment thing;
String associateName = thing.GetAssociateName();

GetBookingType()

Simple read-only appointment data.

Declaration

Integer GetBookingType()

Returns

Type	Description
Integer	The type of booking the appointment represents.

Examples

NSAppointment thing;
Integer bookingType = thing.GetBookingType();

GetCautionWarning()

Simple read-only appointment data.

Declaration

Integer GetCautionWarning()

Returns

Type	Description
Integer	Status field to indicate appointments that have some sort of problem. See AppointmentCautionWarning

Examples

NSAppointment thing;
Integer cautionWarning = thing.GetCautionWarning();

GetColorIndex()

Simple read-only appointment data.

Declaration

Integer GetColorIndex()

Returns

Type	Description
Integer	Appointment color, used only in Japanese versions. Western versions take colour from Task. See ColorIndex.

Examples

NSAppointment thing;
Integer colorIndex = thing.GetColorIndex();

GetCompleted()

Simple read-only appointment data.

Declaration

Integer GetCompleted()

Returns

Type	Description
Integer	The Completed state.

Examples

NSAppointment thing;
Integer completed = thing.GetCompleted();

GetContactId()

Simple read-only appointment data.

Declaration

Integer GetContactId()

Returns

Type	Description
Integer	Contact ID of owning contact, may be 0

Examples

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

GetContactName()

Simple read-only appointment data.

Declaration

String GetContactName()

Returns

Type	Description
String	The contact associated with the appointment.

Examples

NSAppointment thing;
String contactName = thing.GetContactName();

GetCreatedBy()

Simple read-only appointment data.

Declaration

String GetCreatedBy()

Returns

Type	Description
String	Who created the appointment. Associate name.

Examples

NSAppointment thing;
String createdBy = thing.GetCreatedBy();

GetCreatedByAssociateId()

Simple read-only appointment data.

Declaration

Integer GetCreatedByAssociateId()

Returns

Type	Description
Integer	ID of the associate that created the appointment.

Examples

NSAppointment thing;
Integer createdByAssociateId = thing.GetCreatedByAssociateId();

GetCreatedByFullName()

Simple read-only appointment data.

Declaration

String GetCreatedByFullName()

Returns

Type	Description
String	Who created the appointment. Full name.

Examples

NSAppointment thing;
String createdByFullName = thing.GetCreatedByFullName();

GetCreatedDate()

Simple read-only appointment data.

Declaration

DateTime GetCreatedDate()

Returns

Type	Description
DateTime	Appointment creation date.

Examples

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

GetDescription()

Simple read-only appointment data.

Declaration

String GetDescription()

Returns

Type	Description
String	The appointment's textbox; holds a descriptive text about the appointment. Filled out by the user.

Examples

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

GetEndDate()

Simple read-only appointment data.

Declaration

DateTime GetEndDate()

Returns

Type	Description
DateTime	Date + end time planned.

Examples

NSAppointment thing;
DateTime endDate = thing.GetEndDate();

GetFreeBusy()

Simple read-only appointment data.

Declaration

Integer GetFreeBusy()

Returns

Type	Description
Integer	What kind of time is this? 0 = Busy, 1 = Free.

GetHasAlarm()

Simple read-only appointment data.

Declaration

Bool GetHasAlarm()

Returns

Type	Description
Bool	Does this appointment have an alarm.

Examples

NSAppointment thing;
Bool hasAlarm = thing.GetHasAlarm();

GetInvitationStatus()

Simple read-only appointment data.

Declaration

Integer GetInvitationStatus()

Returns

Type	Description
Integer	Status if this appointment represents an invitation.

Examples

NSAppointment thing;
Integer invitationStatus = thing.GetInvitationStatus();

GetIsAlldayEvent()

Simple read-only appointment data.

Declaration

Bool GetIsAlldayEvent()

Returns

Type	Description
Bool	True if all day event.

Examples

NSAppointment thing;
Bool isAlldayEvent = thing.GetIsAlldayEvent();

GetIsBooking()

Simple read-only appointment data.

Declaration

Bool GetIsBooking()

Returns

Type	Description
Bool	True if this appointment is a booking.

Examples

NSAppointment thing;
Bool isBooking = thing.GetIsBooking();

GetIsBookingMain()

Simple read-only appointment data.

Declaration

Bool GetIsBookingMain()

Returns

Type	Description
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.

Examples

NSAppointment thing;
Bool isBookingMain = thing.GetIsBookingMain();

GetIsFree()

Simple read-only appointment data.

Declaration

Bool GetIsFree()

Returns

Type	Description
Bool	True if free, false if busy.

Examples

NSAppointment thing;
Bool isFree = thing.GetIsFree();

GetIsPublished()

Simple read-only appointment data.

Declaration

Bool GetIsPublished()

Returns

Type	Description
Bool	True if appointment have an entry in published table.

Examples

NSAppointment thing;
Bool isPublished = thing.GetIsPublished();

GetIsRecurrence()

Simple read-only appointment data.

Declaration

Bool GetIsRecurrence()

Returns

Type	Description
Bool	True if the appointment is part of a recurring pattern.

Examples

NSAppointment thing;
Bool isRecurrence = thing.GetIsRecurrence();

GetJoinVideomeetUrl()

Simple read-only appointment data.

Declaration

String GetJoinVideomeetUrl()

Returns

Type	Description
String	Blank when not a video meeting. Filled with Join Meeting URL when created.

Examples

NSAppointment thing;
String joinVideomeetUrl = thing.GetJoinVideomeetUrl();

GetLocation()

Simple read-only appointment data.

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

NSAppointment thing;
String location = thing.GetLocation();

GetMotherId()

Simple read-only appointment data.

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

NSAppointment thing;
Integer motherId = thing.GetMotherId();

GetPersonFullName()

Simple read-only appointment data.

Declaration

String GetPersonFullName()

Returns

Type	Description
String	The full name of the person this appointment belongs to.

Examples

NSAppointment thing;
String personFullName = thing.GetPersonFullName();

GetPersonId()

Simple read-only appointment data.

Declaration

Integer GetPersonId()

Returns

Type	Description
Integer	Person ID of person the appointment is with, may be 0

Examples

NSAppointment thing;
Integer personId = thing.GetPersonId();

GetPriorityId()

Simple read-only appointment data.

Declaration

Integer GetPriorityId()

Returns

Type	Description
Integer	Link to priority list.

Examples

NSAppointment thing;
Integer priorityId = thing.GetPriorityId();

GetPriorityName()

Simple read-only appointment data.

Declaration

String GetPriorityName()

Returns

Type	Description
String	Name of the appointments priority.

Examples

NSAppointment thing;
String priorityName = thing.GetPriorityName();

GetPrivate()

Simple read-only appointment data.

Declaration

Integer GetPrivate()

Returns

Type	Description
AppointmentPrivate	De-normalization of visibleFor status. See AppointmentPrivate

Remarks

Obsolete, but still maintained field for appointment privacy.

Examples

NSAppointment thing;
Integer private = thing.GetPrivate();

GetProjectId()

Simple read-only appointment data.

Declaration

Integer GetProjectId()

Returns

Type	Description
Integer	ID of project referred to, may be 0

Examples

NSAppointment thing;
Integer projectId = thing.GetProjectId();

GetProjectName()

Simple read-only appointment data.

Declaration

String GetProjectName()

Returns

Type	Description
String	The name of the project this appointment belong to. Blank if no project is connected.

Examples

NSAppointment thing;
String projectName = thing.GetProjectName();

GetRecurringEndDate()

Simple read-only appointment data.

Declaration

DateTime GetRecurringEndDate()

Returns

Type	Description
DateTime

Examples

NSAppointment thing;
DateTime recurringEndDate = thing.GetRecurringEndDate();

GetRecurringPattern()

Simple read-only appointment data.

Declaration

Integer GetRecurringPattern()

Returns

Type	Description
Integer	See RecurrencePattern

Examples

NSAppointment thing;
Integer recurringPattern = thing.GetRecurringPattern();

GetRecurringStartDate()

Simple read-only appointment data.

Declaration

DateTime GetRecurringStartDate()

Returns

Type	Description
DateTime

Examples

NSAppointment thing;
DateTime recurringStartDate = thing.GetRecurringStartDate();

GetRejectReason()

Simple read-only appointment data.

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

NSAppointment thing;
String rejectReason = thing.GetRejectReason();

GetSaleId()

Simple read-only appointment data.

Declaration

Integer GetSaleId()

Returns

Type	Description
Integer	Owning sale, if any (may be 0).

Examples

NSAppointment thing;
Integer saleId = thing.GetSaleId();

GetSaleName()

Simple read-only appointment data.

Declaration

String GetSaleName()

Returns

Type	Description
String	Heading of Owning sale, if any. (may be blank).

Examples

NSAppointment thing;
String saleName = thing.GetSaleName();

GetStartDate()

Simple read-only appointment data.

Declaration

DateTime GetStartDate()

Returns

Type	Description
DateTime	date + start time planned.

Examples

NSAppointment thing;
DateTime startDate = thing.GetStartDate();

GetTask()

Simple read-only appointment data.

Declaration

String GetTask()

Returns

Type	Description
String

Remarks

Task comprises the different types of activities, like "Phone call", "Meeting" and so on.

Examples

NSAppointment thing;
String task = thing.GetTask();

GetTaskType()

Simple read-only appointment data.

Declaration

Integer GetTaskType()

Returns

Type	Description
Integer	The different task types of the appointment, if the activity is an appointment, task, phone. See TaskType

Examples

NSAppointment thing;
Integer taskType = thing.GetTaskType();

GetType()

Simple read-only appointment data.

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.

Remarks

See the different types of appointments in the database manual.

Examples

NSAppointment thing;
Integer type = thing.GetType();

SetActiveDate(DateTime)

Simple read-only appointment data.

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

NSAppointment thing;
DateTime activeDate;
thing.SetActiveDate(activeDate);

SetAlarmLeadTime(TimeSpan)

Simple read-only appointment data.

Declaration

Void SetAlarmLeadTime(TimeSpan alarmLeadTime)

Parameters

Type	Name	Description
TimeSpan	alarmLeadTime	Alarm lead time.

Returns

Type	Description
Void

Examples

NSAppointment thing;
TimeSpan alarmLeadTime;
thing.SetAlarmLeadTime(alarmLeadTime);

SetAlldayEvent(Integer)

Simple read-only appointment data.

Declaration

Void SetAlldayEvent(Integer allDayEvent)

Parameters

Type	Name	Description
Integer	allDayEvent	Is this an all day event? 0 = No, 1 = Yes.

Returns

Type	Description
Void

SetAppointmentId(Integer)

Simple read-only appointment data.

Declaration

Void SetAppointmentId(Integer appointmentId)

Parameters

Type	Name	Description
Integer	appointmentId	Primary key.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);

SetAssignedBy(Integer)

Simple read-only appointment data.

Declaration

Void SetAssignedBy(Integer assignedBy)

Parameters

Type	Name	Description
Integer	assignedBy	Who (last) assigned this appointment to associate_id?

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer assignedBy;
thing.SetAssignedBy(assignedBy);

SetAssignedByFullName(String)

Simple read-only appointment data.

Declaration

Void SetAssignedByFullName(String assignedByFullName)

Parameters

Type	Name	Description
String	assignedByFullName	The associate's culture formatted fullname (firstname, middleName and lastname).

Returns

Type	Description
Void

Examples

NSAppointment thing;
String assignedByFullName;
thing.SetAssignedByFullName(assignedByFullName);

SetAssignmentStatus(Integer)

Simple read-only appointment data.

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

NSAppointment thing;
Integer assignmentStatus;
thing.SetAssignmentStatus(assignmentStatus);

SetAssociateFullName(String)

Simple read-only appointment data.

Declaration

Void SetAssociateFullName(String associateFullName)

Parameters

Type	Name	Description
String	associateFullName	The owner of the appointment - the associate whose diary/checklist the appointment is in.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String associateFullName;
thing.SetAssociateFullName(associateFullName);

SetAssociateId(Integer)

Simple read-only appointment data.

Declaration

Void SetAssociateId(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId	ID of associate whose diary the appointment is in, REQUIREd.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer associateId;
thing.SetAssociateId(associateId);

SetAssociateName(String)

Simple read-only appointment data.

Declaration

Void SetAssociateName(String associateName)

Parameters

Type	Name	Description
String	associateName	The associate's name.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String associateName;
thing.SetAssociateName(associateName);

SetBookingType(Integer)

Simple read-only appointment data.

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

NSAppointment thing;
Integer bookingType;
thing.SetBookingType(bookingType);

SetCautionWarning(Integer)

Simple read-only appointment data.

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

NSAppointment thing;
Integer cautionWarning;
thing.SetCautionWarning(cautionWarning);

SetColorIndex(Integer)

Simple read-only appointment data.

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

NSAppointment thing;
Integer colorIndex;
thing.SetColorIndex(colorIndex);

SetCompleted(Integer)

Simple read-only appointment data.

Declaration

Void SetCompleted(Integer completed)

Parameters

Type	Name	Description
Integer	completed	The Completed state. See ActivityStatus.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer completed;
thing.SetCompleted(completed);

SetContactId(Integer)

Simple read-only appointment data.

Declaration

Void SetContactId(Integer contactId)

Parameters

Type	Name	Description
Integer	contactId	Contact ID of owning contact, may be 0

Returns

Type	Description
Void

Examples

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

SetContactName(String)

Simple read-only appointment data.

Declaration

Void SetContactName(String contactName)

Parameters

Type	Name	Description
String	contactName	The contact associated with the appointment.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String contactName;
thing.SetContactName(contactName);

SetCreatedBy(String)

Simple read-only appointment data.

Declaration

Void SetCreatedBy(String createdBy)

Parameters

Type	Name	Description
String	createdBy	Who created the appointment. Associate name.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String createdBy;
thing.SetCreatedBy(createdBy);

SetCreatedByAssociateId(Integer)

Simple read-only appointment data.

Declaration

Void SetCreatedByAssociateId(Integer createdByAssociateId)

Parameters

Type	Name	Description
Integer	createdByAssociateId	ID of the associate that created the appointment.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer createdByAssociateId;
thing.SetCreatedByAssociateId(createdByAssociateId);

SetCreatedByFullName(String)

Simple read-only appointment data.

Declaration

Void SetCreatedByFullName(String createdByFullName)

Parameters

Type	Name	Description
String	createdByFullName	Who created the appointment. Full name.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String createdByFullName;
thing.SetCreatedByFullName(createdByFullName);

SetCreatedDate(DateTime)

Simple read-only appointment data.

Declaration

Void SetCreatedDate(DateTime createdDate)

Parameters

Type	Name	Description
DateTime	createdDate	Appointment creation date.

Returns

Type	Description
Void

Examples

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

SetDescription(String)

Simple read-only appointment data.

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	The appointment's textbox; holds a descriptive text about the appointment. Filled out by the user.

Returns

Type	Description
Void

Examples

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

SetEndDate(DateTime)

Simple read-only appointment data.

Declaration

Void SetEndDate(DateTime endDate)

Parameters

Type	Name	Description
DateTime	endDate	Date + end time planned.

Returns

Type	Description
Void

Examples

NSAppointment thing;
DateTime endDate;
thing.SetEndDate(endDate);

SetFreeBusy(Integer)

Simple read-only appointment data.

Declaration

Void SetFreeBusy(Integer freeBusy)

Parameters

Type	Name	Description
Integer	freeBusy	What kind of time is this? 0 = Busy, 1 = Free.

Returns

Type	Description
Void

SetHasAlarm(Bool)

Simple read-only appointment data.

Declaration

Void SetHasAlarm(Bool hasAlarm)

Parameters

Type	Name	Description
Bool	hasAlarm	Does this appointment have an alarm?

Returns

Type	Description
Void

Examples

NSAppointment thing;
Bool hasAlarm;
thing.SetHasAlarm(hasAlarm);

SetInvitationStatus(Integer)

Simple read-only appointment data.

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

NSAppointment thing;
Integer invitationStatus;
thing.SetInvitationStatus(invitationStatus);

SetIsAlldayEvent(Bool)

Simple read-only appointment data.

Declaration

Void SetIsAlldayEvent(Bool isAlldayEvent)

Parameters

Type	Name	Description
Bool	isAlldayEvent	True if all day event.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Bool isAlldayEvent;
thing.SetIsAlldayEvent(isAlldayEvent);

SetIsBooking(Bool)

Simple read-only appointment data.

Declaration

Void SetIsBooking(Bool isBooking)

Parameters

Type	Name	Description
Bool	isBooking	True if this appointment is a booking.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Bool isBooking;
thing.SetIsBooking(isBooking);

SetIsBookingMain(Bool)

Simple read-only appointment data.

Declaration

Void SetIsBookingMain(Bool isBookingMain)

Parameters

Type	Name	Description
Bool	isBookingMain	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.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Bool isBookingMain;
thing.SetIsBookingMain(isBookingMain);

SetIsFree(Bool)

Simple read-only appointment data.

Declaration

Void SetIsFree(Bool isFree)

Parameters

Type	Name	Description
Bool	isFree	True if free, false if busy.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Bool isFree;
thing.SetIsFree(isFree);

SetIsPublished(Bool)

Simple read-only appointment data.

Declaration

Void SetIsPublished(Bool isPublished)

Parameters

Type	Name	Description
Bool	isPublished	True if appointment have an entry in published table.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Bool isPublished;
thing.SetIsPublished(isPublished);

SetIsRecurrence(Bool)

Simple read-only appointment data.

Declaration

Void SetIsRecurrence(Bool isRecurrence)

Parameters

Type	Name	Description
Bool	isRecurrence	True if the appointment is part of a recurring pattern.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Bool isRecurrence;
thing.SetIsRecurrence(isRecurrence);

SetJoinVideomeetUrl(String)

Simple read-only appointment data.

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

NSAppointment thing;
String joinVideomeetUrl;
thing.SetJoinVideomeetUrl(joinVideomeetUrl);

SetLocation(String)

Simple read-only appointment data.

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

NSAppointment thing;
String location;
thing.SetLocation(location);

SetMotherId(Integer)

Simple read-only appointment data.

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. However, if 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer motherId;
thing.SetMotherId(motherId);

SetPersonFullName(String)

Simple read-only appointment data.

Declaration

Void SetPersonFullName(String personFullName)

Parameters

Type	Name	Description
String	personFullName	The full name of the person this appointment belongs to.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String personFullName;
thing.SetPersonFullName(personFullName);

SetPersonId(Integer)

Simple read-only appointment data.

Declaration

Void SetPersonId(Integer personId)

Parameters

Type	Name	Description
Integer	personId	Person ID of person the appointment is with, may be 0

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer personId;
thing.SetPersonId(personId);

SetPriorityId(Integer)

Simple read-only appointment data.

Declaration

Void SetPriorityId(Integer priorityId)

Parameters

Type	Name	Description
Integer	priorityId	Link to priority list.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer priorityId;
thing.SetPriorityId(priorityId);

SetPriorityName(String)

Simple read-only appointment data.

Declaration

Void SetPriorityName(String priorityName)

Parameters

Type	Name	Description
String	priorityName	Name of the appointments priority.

Returns

Type	Description

Examples

NSAppointment thing;
String priorityName;
thing.SetPriorityName(priorityName);

SetPrivate(Integer)

Obsolete, but still maintained field for appointment privacy.

Declaration

Void SetPrivate(Integer private)

Parameters

Type	Name	Description
Integer	private	de-normalization of visibleFor status. See AppointmentPrivate.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer private;
thing.SetPrivate(private);

SetProjectId(Integer)

Simple read-only appointment data.

Declaration

Void SetProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	ID of project referred to, may be 0

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer projectId;
thing.SetProjectId(projectId);

SetProjectName(String)

Simple read-only appointment data.

Declaration

Void SetProjectName(String projectName)

Parameters

Type	Name	Description
String	projectName	The name of the project this appointment belong to. Blank if no project is connected.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String projectName;
thing.SetProjectName(projectName);

SetRecurringEndDate(DateTime)

Simple read-only appointment data.

Declaration

Void SetRecurringEndDate(DateTime recurringEndDate)

Parameters

Type	Name	Description
DateTime	recurringEndDate

Returns

Type	Description
Void

Examples

NSAppointment thing;
DateTime recurringEndDate;
thing.SetRecurringEndDate(recurringEndDate);

SetRecurringPattern(Integer)

Simple read-only appointment data.

Declaration

Void SetRecurringPattern(Integer pattern)

Parameters

Type	Name	Description
Integer	pattern	See RecurrencePattern.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer pattern;
thing.SetRecurringPattern(pattern);

SetRecurringStartDate(DateTime)

Simple read-only appointment data.

Declaration

Void SetRecurringStartDate(DateTime recurringStartDate)

Parameters

Type	Name	Description
DateTime	recurringStartDate

Returns

Type	Description
Void

Examples

NSAppointment thing;
DateTime recurringStartDate;
thing.SetRecurringStartDate(recurringStartDate);

SetRejectReason(String)

Simple read-only appointment data.

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

NSAppointment thing;
String rejectReason;
thing.SetRejectReason(rejectReason);

SetSaleId(Integer)

Simple read-only appointment data.

Declaration

Void SetSaleId(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId	Owning sale, if any (may be 0).

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer saleId;
thing.SetSaleId(saleId);

SetSaleName(String)

Simple read-only appointment data.

Declaration

Void SetSaleName(String saleName)

Parameters

Type	Name	Description
String	saleName	Heading of Owning sale, if any. (may be blank).

Returns

Type	Description
Void

Examples

NSAppointment thing;
String saleName;
thing.SetSaleName(saleName);

SetStartDate(DateTime)

Simple read-only appointment data.

Declaration

Void SetStartDate(DateTime startDate)

Parameters

Type	Name	Description
DateTime	startDate	date + start time planned.

Returns

Type	Description
Void

Examples

NSAppointment thing;
DateTime startDate;
thing.SetStartDate(startDate);

SetTask(String)

Simple read-only appointment data.

Declaration

Void SetTask(String task)

Parameters

Type	Name	Description
String	task	Task comprises the different types of activities, such as Phone call or Meeting.

Returns

Type	Description
Void

Examples

NSAppointment thing;
String task;
thing.SetTask(task);

SetTaskType(Integer)

Simple read-only appointment data.

Declaration

Void SetTaskType(Integer taskType)

Parameters

Type	Name	Description
Integer	taskType	The different task types of the appointment, if the activity is an appointment, task, phone. See TaskType.

Returns

Type	Description
Void

Examples

NSAppointment thing;
Integer taskType;
thing.SetTaskType(taskType);

SetType(Integer)

Simple read-only appointment data.

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

NSAppointment thing;
Integer type;
thing.SetType(type);