Class NSAlarmData

Carrier object for AlarmData.

Syntax

Constructors

NSAlarmData()

Initializes a new instance of the NSAlarmData class.

Declaration

NSAlarmData

Methods

GetAlarmTime()

Carrier object for AlarmData.

Declaration

DateTime GetAlarmTime()

Returns

Type	Description
DateTime

Examples

NSAlarmData thing;
DateTime alarmTime = thing.GetAlarmTime();

GetAppointmentId()

Carrier object for AlarmData.

Declaration

Integer GetAppointmentId()

Returns

Type	Description
Integer	Appointment ID (primary key).

Examples

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

GetAppointmentText()

Carrier object for AlarmData.

Declaration

String GetAppointmentText()

Returns

Type	Description
String	The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases.

Examples

NSAlarmData thing;
String appointmentText = thing.GetAppointmentText();

GetAppointmentType()

where=no start time,note,docin, docout

Declaration

Integer GetAppointmentType()

Returns

Type	Description
Integer	See AppointmentType

Examples

NSAlarmData thing;
Integer appointmentType = thing.GetAppointmentType();

GetAssignmentStatus()

Carrier object for AlarmData.

Declaration

Integer GetAssignmentStatus()

Returns

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

Examples

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

GetBookingType()

Carrier object for AlarmData.

Declaration

Integer GetBookingType()

Returns

Type	Description
Integer	The type of booking the appointment represents.

Examples

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

GetContactDepartment()

Carrier object for AlarmData.

Declaration

String GetContactDepartment()

Returns

Type	Description
String	Department.

Examples

NSAlarmData thing;
String contactDepartment = thing.GetContactDepartment();

GetContactFullName()

Carrier object for AlarmData.

Declaration

String GetContactFullName()

Returns

Type	Description
String

Examples

NSAlarmData thing;
String contactFullName = thing.GetContactFullName();

GetContactId()

Carrier object for AlarmData.

Declaration

Integer GetContactId()

Returns

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

Examples

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

GetContactName()

Carrier object for AlarmData.

Declaration

String GetContactName()

Returns

Type	Description
String	Contact name.

Examples

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

GetEndDate()

Carrier object for AlarmData.

Declaration

DateTime GetEndDate()

Returns

Type	Description
DateTime	Date + end time planned.

Examples

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

GetFormalName()

Carrier object for AlarmData.

Declaration

String GetFormalName()

Returns

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

Examples

NSAlarmData thing;
String formalName = thing.GetFormalName();

GetInvitationStatus()

Carrier object for AlarmData.

Declaration

Integer GetInvitationStatus()

Returns

Type	Description
Integer	Status if this appointment represents an invitation.

Examples

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

GetLocation()

Carrier object for AlarmData.

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

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

GetPersonFullName()

Carrier object for AlarmData.

Declaration

String GetPersonFullName()

Returns

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

Examples

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

GetPersonId()

Carrier object for AlarmData.

Declaration

Integer GetPersonId()

Returns

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

Examples

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

GetProjectId()

Carrier object for AlarmData.

Declaration

Integer GetProjectId()

Returns

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

Examples

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

GetProjectName()

Carrier object for AlarmData.

Declaration

String GetProjectName()

Returns

Type	Description
String	Project name.

Examples

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

GetSaleId()

Carrier object for AlarmData.

Declaration

Integer GetSaleId()

Returns

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

Examples

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

GetSaleName()

Carrier object for AlarmData.

Declaration

String GetSaleName()

Returns

Type	Description
String

Examples

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

GetStartTime()

Carrier object for AlarmData.

Declaration

DateTime GetStartTime()

Returns

Type	Description
DateTime	date + start time planned.

Examples

NSAlarmData thing;
DateTime startTime = thing.GetStartTime();

GetTaskName()

Carrier object for AlarmData.

Declaration

String GetTaskName()

Returns

Type	Description
String

Examples

NSAlarmData thing;
String taskName = thing.GetTaskName();

SetAlarmTime(DateTime)

Carrier object for AlarmData.

Declaration

Void SetAlarmTime(DateTime alarmTime)

Parameters

Type	Name	Description
DateTime	alarmTime

Returns

Type	Description
Void

Examples

NSAlarmData thing;
DateTime alarmTime;
thing.SetAlarmTime(alarmTime);

SetAppointmentId(Integer)

Carrier object for AlarmData.

Declaration

Void SetAppointmentId(Integer appointmentId)

Parameters

Type	Name	Description
Integer	appointmentId	Appointment ID (primary key).

Returns

Type	Description
Void

Examples

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

SetAppointmentText(String)

Carrier object for AlarmData.

Declaration

Void SetAppointmentText(String appointmentText)

Parameters

Type	Name	Description
String	appointmentText	The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases.

Returns

Type	Description
Void

Examples

NSAlarmData thing;
String appointmentText;
thing.SetAppointmentText(appointmentText);

SetAppointmentType(Integer)

Carrier object for AlarmData.

Declaration

Void SetAppointmentType(Integer appointmentType)

Parameters

Type	Name	Description
Integer	appointmentType	See AppointmentType

Returns

Type	Description
Void

Remarks

where=no start time,note,docin, docout

Examples

NSAlarmData thing;
Integer appointmentType;
thing.SetAppointmentType(appointmentType);

SetAssignmentStatus(Integer)

Carrier object for AlarmData.

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

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

SetBookingType(Integer)

Carrier object for AlarmData.

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

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

SetContactDepartment(String)

Carrier object for AlarmData.

Declaration

Void SetContactDepartment(String contactDepartment)

Parameters

Type	Name	Description
String	contactDepartment	Department.

Returns

Type	Description
Void

Examples

NSAlarmData thing;
String contactDepartment;
thing.SetContactDepartment(contactDepartment);

SetContactFullName(String)

Carrier object for AlarmData.

Declaration

Void SetContactFullName(String contactFullName)

Parameters

Type	Name	Description
String	contactFullName

Returns

Type	Description
Void

Examples

NSAlarmData thing;
String contactFullName;
thing.SetContactFullName(contactFullName);

SetContactId(Integer)

Carrier object for AlarmData.

Declaration

Void SetContactId(Integer contactId)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetContactName(String)

Carrier object for AlarmData.

Declaration

Void SetContactName(String contactName)

Parameters

Type	Name	Description
String	contactName	Contact name.

Returns

Type	Description
Void

Examples

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

SetEndDate(DateTime)

Carrier object for AlarmData.

Declaration

Void SetEndDate(DateTime endDate)

Parameters

Type	Name	Description
DateTime	endDate	Date + end time planned.

Returns

Type	Description
Void

Examples

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

SetFormalName(String)

Carrier object for AlarmData.

Declaration

Void SetFormalName(String formalName)

Parameters

Type	Name	Description
String	formalName	The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs).

Returns

Type	Description
Void

Examples

NSAlarmData thing;
String formalName;
thing.SetFormalName(formalName);

SetInvitationStatus(Integer)

Carrier object for AlarmData.

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

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

SetLocation(String)

Carrier object for AlarmData.

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

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

SetPersonFullName(String)

Carrier object for AlarmData.

Declaration

Void SetPersonFullName(String personFullName)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetPersonId(Integer)

Carrier object for AlarmData.

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

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

SetProjectId(Integer)

Carrier object for AlarmData.

Declaration

Void SetProjectId(Integer projectId)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetProjectName(String)

Carrier object for AlarmData.

Declaration

Void SetProjectName(String projectName)

Parameters

Type	Name	Description
String	projectName	Project name.

Returns

Type	Description
Void

Examples

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

SetSaleId(Integer)

Carrier object for AlarmData.

Declaration

Void SetSaleId(Integer saleId)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetSaleName(String)

Carrier object for AlarmData.

Declaration

Void SetSaleName(String saleName)

Parameters

Type	Name	Description
String	saleName

Returns

Type	Description
Void

Examples

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

SetStartTime(DateTime)

Carrier object for AlarmData.

Declaration

Void SetStartTime(DateTime startTime)

Parameters

Type	Name	Description
DateTime	startTime	date + start time planned.

Returns

Type	Description
Void

Examples

NSAlarmData thing;
DateTime startTime;
thing.SetStartTime(startTime);

SetTaskName(String)

Carrier object for AlarmData.

Declaration

Void SetTaskName(String taskName)

Parameters

Type	Name	Description
String	taskName

Returns

Type	Description
Void

Examples

NSAlarmData thing;
String taskName;
thing.SetTaskName(taskName);