Show / Hide Table of Contents

Class NSAppointmentSyncData

Carrier object for AppointmentSyncData.

Syntax

Constructors

NSAppointmentSyncData()

Initializes a new instance of the NSAppointmentSyncData class.

Declaration
NSAppointmentSyncData

Methods

GetAlarmTime()

Carrier object for AppointmentSyncData.

Declaration
DateTime GetAlarmTime()
Returns
Type Description
DateTime

Date and time at which to show alarm.

Examples
NSAppointmentSyncData thing;
DateTime alarmTime = thing.GetAlarmTime();

GetAppointmentId()

Carrier object for AppointmentSyncData.

Declaration
Integer GetAppointmentId()
Returns
Type Description
Integer
Examples
NSAppointmentSyncData thing;
Integer appointmentId = thing.GetAppointmentId();

GetAppointmentText()

Carrier object for AppointmentSyncData.

Declaration
String GetAppointmentText()
Returns
Type Description
String

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

Examples
NSAppointmentSyncData thing;
String appointmentText = thing.GetAppointmentText();

GetContactDepartment()

Carrier object for AppointmentSyncData.

Declaration
String GetContactDepartment()
Returns
Type Description
String

The department of the contact connected to the appointment.

Examples
NSAppointmentSyncData thing;
String contactDepartment = thing.GetContactDepartment();

GetContactFullName()

Carrier object for AppointmentSyncData.

Declaration
String GetContactFullName()
Returns
Type Description
String

The entire name of the contact, including department name.

Examples
NSAppointmentSyncData thing;
String contactFullName = thing.GetContactFullName();

GetContactId()

Carrier object for AppointmentSyncData.

Declaration
Integer GetContactId()
Returns
Type Description
Integer

The contacts identifier.

Examples
NSAppointmentSyncData thing;
Integer contactId = thing.GetContactId();

GetContactName()

Carrier object for AppointmentSyncData.

Declaration
String GetContactName()
Returns
Type Description
String

The contact associated with the appointment.

Examples
NSAppointmentSyncData thing;
String contactName = thing.GetContactName();

GetEndDate()

Carrier object for AppointmentSyncData.

Declaration
DateTime GetEndDate()
Returns
Type Description
DateTime

Date + end time planned.

Examples
NSAppointmentSyncData thing;
DateTime endDate = thing.GetEndDate();

GetHasAlarm()

Carrier object for AppointmentSyncData.

Declaration
Bool GetHasAlarm()
Returns
Type Description
Bool

Does this appointment have an alarm?

Examples
NSAppointmentSyncData thing;
Bool hasAlarm = thing.GetHasAlarm();

GetIsAllDay()

Carrier object for AppointmentSyncData.

Declaration
Bool GetIsAllDay()
Returns
Type Description
Bool
Examples
NSAppointmentSyncData thing;
Bool isAllDay = thing.GetIsAllDay();

GetIsAssignment()

Carrier object for AppointmentSyncData.

Declaration
Bool GetIsAssignment()
Returns
Type Description
Bool
Examples
NSAppointmentSyncData thing;
Bool isAssignment = thing.GetIsAssignment();

GetIsBusy()

Carrier object for AppointmentSyncData.

Declaration
Bool GetIsBusy()
Returns
Type Description
Bool
Examples
NSAppointmentSyncData thing;
Bool isBusy = thing.GetIsBusy();

GetIsCompleted()

Carrier object for AppointmentSyncData.

Declaration
Bool GetIsCompleted()
Returns
Type Description
Bool
Examples
NSAppointmentSyncData thing;
Bool isCompleted = thing.GetIsCompleted();

GetIsInvitation()

Carrier object for AppointmentSyncData.

Declaration
Bool GetIsInvitation()
Returns
Type Description
Bool
Examples
NSAppointmentSyncData thing;
Bool isInvitation = thing.GetIsInvitation();

GetIsTentative()

Carrier object for AppointmentSyncData.

Declaration
Bool GetIsTentative()
Returns
Type Description
Bool
Examples
NSAppointmentSyncData thing;
Bool isTentative = thing.GetIsTentative();

GetLocation()

Carrier object for AppointmentSyncData.

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
NSAppointmentSyncData thing;
String location = thing.GetLocation();

GetParticipants()

Carrier object for AppointmentSyncData.

Declaration
NSParticipantSyncData[] GetParticipants()
Returns
Type Description
NSParticipantSyncData[]
Examples
NSAppointmentSyncData thing;
NSParticipantSyncData[] participants = thing.GetParticipants();

GetPersonFormalName()

Carrier object for AppointmentSyncData.

Declaration
String GetPersonFormalName()
Returns
Type Description
String
Examples
NSAppointmentSyncData thing;
String personFormalName = thing.GetPersonFormalName();

GetPersonFullName()

Carrier object for AppointmentSyncData.

Declaration
String GetPersonFullName()
Returns
Type Description
String

The full name of the person this appointment belongs to.

Examples
NSAppointmentSyncData thing;
String personFullName = thing.GetPersonFullName();

GetPersonId()

Carrier object for AppointmentSyncData.

Declaration
Integer GetPersonId()
Returns
Type Description
Integer

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

Examples
NSAppointmentSyncData thing;
Integer personId = thing.GetPersonId();

GetProjectId()

Carrier object for AppointmentSyncData.

Declaration
Integer GetProjectId()
Returns
Type Description
Integer

ID of project referred to, may be 0

Examples
NSAppointmentSyncData thing;
Integer projectId = thing.GetProjectId();

GetProjectName()

Project name

Declaration
String GetProjectName()
Returns
Type Description
String
Examples
NSAppointmentSyncData thing;
String projectName = thing.GetProjectName();

GetSaleId()

Carrier object for AppointmentSyncData.

Declaration
Integer GetSaleId()
Returns
Type Description
Integer

Owning sale, if any (may be 0).

Examples
NSAppointmentSyncData thing;
Integer saleId = thing.GetSaleId();

GetSaleName()

Carrier object for AppointmentSyncData.

Declaration
String GetSaleName()
Returns
Type Description
String

Sale heading (short description?).

Examples
NSAppointmentSyncData thing;
String saleName = thing.GetSaleName();

GetStartDate()

Carrier object for AppointmentSyncData.

Declaration
DateTime GetStartDate()
Returns
Type Description
DateTime

date + start time planned.

Examples
NSAppointmentSyncData thing;
DateTime startDate = thing.GetStartDate();

GetTaskName()

Carrier object for AppointmentSyncData.

Declaration
String GetTaskName()
Returns
Type Description
String
Examples
NSAppointmentSyncData thing;
String taskName = thing.GetTaskName();

SetAlarmTime(DateTime)

Carrier object for AppointmentSyncData.

Declaration
Void SetAlarmTime(DateTime alarmTime)
Parameters
Type Name Description
DateTime alarmTime

Date and time at which to show alarm.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
DateTime alarmTime;
thing.SetAlarmTime(alarmTime);

SetAppointmentId(Integer)

Carrier object for AppointmentSyncData.

Declaration
Void SetAppointmentId(Integer appointmentId)
Parameters
Type Name Description
Integer appointmentId

Primary key.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);

SetAppointmentText(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetAppointmentText(String appointmentText)
Parameters
Type Name Description
String appointmentText

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

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String appointmentText;
thing.SetAppointmentText(appointmentText);

SetContactDepartment(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetContactDepartment(String contactDepartment)
Parameters
Type Name Description
String contactDepartment

The department of the contact connected to the appointment.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String contactDepartment;
thing.SetContactDepartment(contactDepartment);

SetContactFullName(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetContactFullName(String contactFullName)
Parameters
Type Name Description
String contactFullName

The entire name of the contact, including department name.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String contactFullName;
thing.SetContactFullName(contactFullName);

SetContactId(Integer)

Carrier object for AppointmentSyncData.

Declaration
Void SetContactId(Integer contactId)
Parameters
Type Name Description
Integer contactId

The contacts identifier.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Integer contactId;
thing.SetContactId(contactId);

SetContactName(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetContactName(String contactName)
Parameters
Type Name Description
String contactName

The contact associated with the appointment.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String contactName;
thing.SetContactName(contactName);

SetEndDate(DateTime)

Carrier object for AppointmentSyncData.

Declaration
Void SetEndDate(DateTime endDate)
Parameters
Type Name Description
DateTime endDate

Date + end time planned.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
DateTime endDate;
thing.SetEndDate(endDate);

SetHasAlarm(Bool)

Carrier object for AppointmentSyncData.

Declaration
Void SetHasAlarm(Bool hasAlarm)
Parameters
Type Name Description
Bool hasAlarm

Does this appointment have an alarm.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Bool hasAlarm;
thing.SetHasAlarm(hasAlarm);

SetIsAllDay(Bool)

Carrier object for AppointmentSyncData.

Declaration
Void SetIsAllDay(Bool isAllDay)
Parameters
Type Name Description
Bool isAllDay
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Bool isAllDay;
thing.SetIsAllDay(isAllDay);

SetIsAssignment(Bool)

Carrier object for AppointmentSyncData.

Declaration
Void SetIsAssignment(Bool isAssignment)
Parameters
Type Name Description
Bool isAssignment
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Bool isAssignment;
thing.SetIsAssignment(isAssignment);

SetIsBusy(Bool)

Carrier object for AppointmentSyncData.

Declaration
Void SetIsBusy(Bool isBusy)
Parameters
Type Name Description
Bool isBusy
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Bool isBusy;
thing.SetIsBusy(isBusy);

SetIsCompleted(Bool)

Carrier object for AppointmentSyncData.

Declaration
Void SetIsCompleted(Bool isCompleted)
Parameters
Type Name Description
Bool isCompleted
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Bool isCompleted;
thing.SetIsCompleted(isCompleted);

SetIsInvitation(Bool)

Carrier object for AppointmentSyncData.

Declaration
Void SetIsInvitation(Bool isInvitation)
Parameters
Type Name Description
Bool isInvitation
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Bool isInvitation;
thing.SetIsInvitation(isInvitation);

SetIsTentative(Bool)

Carrier object for AppointmentSyncData.

Declaration
Void SetIsTentative(Bool isTentative)
Parameters
Type Name Description
Bool isTentative
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Bool isTentative;
thing.SetIsTentative(isTentative);

SetLocation(String)

Carrier object for AppointmentSyncData.

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
NSAppointmentSyncData thing;
String location;
thing.SetLocation(location);

SetParticipants(NSParticipantSyncData[])

Carrier object for AppointmentSyncData.

Declaration
Void SetParticipants(NSParticipantSyncData[] participants)
Parameters
Type Name Description
NSParticipantSyncData[] participants
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
NSParticipantSyncData[] participants;
thing.SetParticipants(participants);

SetPersonFormalName(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetPersonFormalName(String personFormalName)
Parameters
Type Name Description
String personFormalName
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String personFormalName;
thing.SetPersonFormalName(personFormalName);

SetPersonFullName(String)

Carrier object for AppointmentSyncData.

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
NSAppointmentSyncData thing;
String personFullName;
thing.SetPersonFullName(personFullName);

SetPersonId(Integer)

Carrier object for AppointmentSyncData.

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
NSAppointmentSyncData thing;
Integer personId;
thing.SetPersonId(personId);

SetProjectId(Integer)

Carrier object for AppointmentSyncData.

Declaration
Void SetProjectId(Integer projectId)
Parameters
Type Name Description
Integer projectId

ID of project referred to, may be 0

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Integer projectId;
thing.SetProjectId(projectId);

SetProjectName(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetProjectName(String projectName)
Parameters
Type Name Description
String projectName

Project name.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String projectName;
thing.SetProjectName(projectName);

SetSaleId(Integer)

Carrier object for AppointmentSyncData.

Declaration
Void SetSaleId(Integer saleId)
Parameters
Type Name Description
Integer saleId

Owning sale, if any (may be 0).

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
Integer saleId;
thing.SetSaleId(saleId);

SetSaleName(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetSaleName(String saleName)
Parameters
Type Name Description
String saleName

Sale heading (short description?).

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String saleName;
thing.SetSaleName(saleName);

SetStartDate(DateTime)

Carrier object for AppointmentSyncData.

Declaration
Void SetStartDate(DateTime startDate)
Parameters
Type Name Description
DateTime startDate

date + start time planned.

Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
DateTime startDate;
thing.SetStartDate(startDate);

SetTaskName(String)

Carrier object for AppointmentSyncData.

Declaration
Void SetTaskName(String taskName)
Parameters
Type Name Description
String taskName
Returns
Type Description
Void
Examples
NSAppointmentSyncData thing;
String taskName;
thing.SetTaskName(taskName);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top