Class NSAlarmData

Carrier object for AlarmData.

Constructors

NSAlarmData()

Initializes a new instance of the NSAlarmData class.

Declaration

NSAlarmData

Methods

GetAlarmTime()

Declaration

DateTime GetAlarmTime()

Examples

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

Returns

Type	Description
DateTime

GetAppointmentId()

Declaration

Integer GetAppointmentId()

Examples

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

Returns

Type	Description
Integer	Appointment ID (primary key).

GetAppointmentText()

Declaration

String GetAppointmentText()

Examples

NSAlarmData thing;
String appointmentText = thing.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.

GetAppointmentType()

where=no start time,note,docin, docout

Declaration

Integer GetAppointmentType()

Examples

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

Returns

Type	Description
Integer	See <xref href="CRMScript.NetServer.AppointmentType" data-throw-if-not-resolved="false"></xref>

GetAssignmentStatus()

Declaration

Integer GetAssignmentStatus()

Examples

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

Returns

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

GetBookingType()

Declaration

Integer GetBookingType()

Examples

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

Returns

Type	Description
Integer	The type of booking the appointment represents.

GetContactDepartment()

Declaration

String GetContactDepartment()

Examples

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

Returns

Type	Description
String	Department.

GetContactFullName()

Declaration

String GetContactFullName()

Examples

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

Returns

Type	Description
String

GetContactId()

Declaration

Integer GetContactId()

Examples

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

Returns

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

GetContactName()

Declaration

String GetContactName()

Examples

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

Returns

Type	Description
String	Contact name.

GetEndDate()

Declaration

DateTime GetEndDate()

Examples

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

Returns

Type	Description
DateTime	Date + end time planned.

GetFormalName()

Declaration

String GetFormalName()

Examples

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

Returns

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

GetInvitationStatus()

Declaration

Integer GetInvitationStatus()

Examples

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

Returns

Type	Description
Integer	Status if this appointment represents an invitation.

GetLocation()

Declaration

String GetLocation()

Examples

NSAlarmData thing;
String location = thing.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.

GetPersonFullName()

Declaration

String GetPersonFullName()

Examples

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

Returns

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

GetPersonId()

Declaration

Integer GetPersonId()

Examples

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

Returns

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

GetProjectId()

Declaration

Integer GetProjectId()

Examples

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

Returns

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

GetProjectName()

Declaration

String GetProjectName()

Examples

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

Returns

Type	Description
String	Project name.

GetSaleId()

Declaration

Integer GetSaleId()

Examples

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

Returns

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

GetSaleName()

Declaration

String GetSaleName()

Examples

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

Returns

Type	Description
String

GetStartTime()

Declaration

DateTime GetStartTime()

Examples

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

Returns

Type	Description
DateTime	date + start time planned.

GetTaskName()

Declaration

String GetTaskName()

Examples

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

Returns

Type	Description
String

SetAlarmTime(DateTime)

Declaration

Void SetAlarmTime(DateTime alarmTime)

Examples

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

Parameters

Type	Name	Description
DateTime	alarmTime

Returns

Type	Description
Void

SetAppointmentId(Integer)

Declaration

Void SetAppointmentId(Integer appointmentId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetAppointmentText(String)

Declaration

Void SetAppointmentText(String appointmentText)

Examples

NSAlarmData thing;
String appointmentText;
thing.SetAppointmentText(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

SetAppointmentType(Integer)

Declaration

Void SetAppointmentType(Integer appointmentType)

Examples

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

Parameters

Type	Name	Description
Integer	appointmentType	See <xref href="CRMScript.NetServer.AppointmentType" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
Void

SetAssignmentStatus(Integer)

Declaration

Void SetAssignmentStatus(Integer assignmentStatus)

Examples

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

Parameters

Type	Name	Description
Integer	assignmentStatus	Status if this appointment is in the process of being assigned to someone else. See <xref href="CRMScript.NetServer.AssignmentStatus" data-throw-if-not-resolved="false"></xref>.

Returns

Type	Description
Void

SetBookingType(Integer)

Declaration

Void SetBookingType(Integer bookingType)

Examples

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

Parameters

Type	Name	Description
Integer	bookingType	The type of booking the appointment represents. See <xref href="CRMScript.NetServer.BookingType" data-throw-if-not-resolved="false"></xref>.

Returns

Type	Description
Void

SetContactDepartment(String)

Declaration

Void SetContactDepartment(String contactDepartment)

Examples

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

Parameters

Type	Name	Description
String	contactDepartment	Department.

Returns

Type	Description
Void

SetContactFullName(String)

Declaration

Void SetContactFullName(String contactFullName)

Examples

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

Parameters

Type	Name	Description
String	contactFullName

Returns

Type	Description
Void

SetContactId(Integer)

Declaration

Void SetContactId(Integer contactId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetContactName(String)

Declaration

Void SetContactName(String contactName)

Examples

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

Parameters

Type	Name	Description
String	contactName	Contact name.

Returns

Type	Description
Void

SetEndDate(DateTime)

Declaration

Void SetEndDate(DateTime endDate)

Examples

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

Parameters

Type	Name	Description
DateTime	endDate	Date + end time planned.

Returns

Type	Description
Void

SetFormalName(String)

Declaration

Void SetFormalName(String formalName)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetInvitationStatus(Integer)

Declaration

Void SetInvitationStatus(Integer invitationStatus)

Examples

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

Parameters

Type	Name	Description
Integer	invitationStatus	Status if this appointment represents an invitation. See <xref href="CRMScript.NetServer.InvitationStatus" data-throw-if-not-resolved="false"></xref>.

Returns

Type	Description
Void

SetLocation(String)

Declaration

Void SetLocation(String location)

Examples

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

SetPersonFullName(String)

Declaration

Void SetPersonFullName(String personFullName)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetPersonId(Integer)

Declaration

Void SetPersonId(Integer personId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetProjectId(Integer)

Declaration

Void SetProjectId(Integer projectId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetProjectName(String)

Declaration

Void SetProjectName(String projectName)

Examples

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

Parameters

Type	Name	Description
String	projectName	Project name.

Returns

Type	Description
Void

SetSaleId(Integer)

Declaration

Void SetSaleId(Integer saleId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetSaleName(String)

Declaration

Void SetSaleName(String saleName)

Examples

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

Parameters

Type	Name	Description
String	saleName

Returns

Type	Description
Void

SetStartTime(DateTime)

Declaration

Void SetStartTime(DateTime startTime)

Examples

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

Parameters

Type	Name	Description
DateTime	startTime	date + start time planned.

Returns

Type	Description
Void

SetTaskName(String)

Declaration

Void SetTaskName(String taskName)

Examples

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

Parameters

Type	Name	Description
String	taskName

Returns

Type	Description
Void