> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSAlarmData

> Carrier object for AlarmData.

Carrier object for AlarmData.

## Constructors

### NSAlarmData()

```crmscript theme={null}
NSAlarmData
```

Initializes a new instance of the NSAlarmData class.

## Methods

## GetAlarmTime()

```crmscript theme={null}
DateTime GetAlarmTime()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
DateTime alarmTime = thing.GetAlarmTime();
```

## GetAppointmentId()

```crmscript theme={null}
Integer GetAppointmentId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Appointment ID (primary key).

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer appointmentId = thing.GetAppointmentId();
```

## GetAppointmentText()

```crmscript theme={null}
String GetAppointmentText()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String appointmentText = thing.GetAppointmentText();
```

## GetAppointmentType()

where=no start time,note,docin, docout

```crmscript theme={null}
Integer GetAppointmentType()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - See \<xref href="CRMScript.NetServer.AppointmentType" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer appointmentType = thing.GetAppointmentType();
```

## GetAssignmentStatus()

```crmscript theme={null}
Integer GetAssignmentStatus()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Status if this appointment is in the process of being assigned to someone else.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer assignmentStatus = thing.GetAssignmentStatus();
```

## GetBookingType()

```crmscript theme={null}
Integer GetBookingType()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The type of booking the appointment represents.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer bookingType = thing.GetBookingType();
```

## GetContactDepartment()

```crmscript theme={null}
String GetContactDepartment()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Department.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String contactDepartment = thing.GetContactDepartment();
```

## GetContactFullName()

```crmscript theme={null}
String GetContactFullName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String contactFullName = thing.GetContactFullName();
```

## GetContactId()

```crmscript theme={null}
Integer GetContactId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Contact ID of owning contact, may be 0.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer contactId = thing.GetContactId();
```

## GetContactName()

```crmscript theme={null}
String GetContactName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Contact name.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String contactName = thing.GetContactName();
```

## GetEndDate()

```crmscript theme={null}
DateTime GetEndDate()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Date + end time planned.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
DateTime endDate = thing.GetEndDate();
```

## GetFormalName()

```crmscript theme={null}
String GetFormalName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs).

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String formalName = thing.GetFormalName();
```

## GetInvitationStatus()

```crmscript theme={null}
Integer GetInvitationStatus()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Status if this appointment represents an invitation.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer invitationStatus = thing.GetInvitationStatus();
```

## GetLocation()

```crmscript theme={null}
String GetLocation()
```

**Returns:** [CRMScript.Global.String](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:**

```crmscript theme={null}
NSAlarmData thing;
String location = thing.GetLocation();
```

## GetPersonFullName()

```crmscript theme={null}
String GetPersonFullName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The associate's culture formatted fullname (firstname, middleName and lastname).

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String personFullName = thing.GetPersonFullName();
```

## GetPersonId()

```crmscript theme={null}
Integer GetPersonId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Person ID of person the appointment is with, may be 0

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer personId = thing.GetPersonId();
```

## GetProjectId()

```crmscript theme={null}
Integer GetProjectId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - ID of project referred to, may be 0

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer projectId = thing.GetProjectId();
```

## GetProjectName()

```crmscript theme={null}
String GetProjectName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Project name.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String projectName = thing.GetProjectName();
```

## GetSaleId()

```crmscript theme={null}
Integer GetSaleId()
```

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

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer saleId = thing.GetSaleId();
```

## GetSaleName()

```crmscript theme={null}
String GetSaleName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String saleName = thing.GetSaleName();
```

## GetStartTime()

```crmscript theme={null}
DateTime GetStartTime()
```

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - date + start time planned.

**Example:**

```crmscript theme={null}
NSAlarmData thing;
DateTime startTime = thing.GetStartTime();
```

## GetTaskName()

```crmscript theme={null}
String GetTaskName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String taskName = thing.GetTaskName();
```

## SetAlarmTime(DateTime)

```crmscript theme={null}
Void SetAlarmTime(DateTime alarmTime)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
DateTime alarmTime;
thing.SetAlarmTime(alarmTime);
```

## SetAppointmentId(Integer)

```crmscript theme={null}
Void SetAppointmentId(Integer appointmentId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer appointmentId;
thing.SetAppointmentId(appointmentId);
```

## SetAppointmentText(String)

```crmscript theme={null}
Void SetAppointmentText(String appointmentText)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String appointmentText;
thing.SetAppointmentText(appointmentText);
```

## SetAppointmentType(Integer)

```crmscript theme={null}
Void SetAppointmentType(Integer appointmentType)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  where=no start time,note,docin, docout
</Note>

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer appointmentType;
thing.SetAppointmentType(appointmentType);
```

## SetAssignmentStatus(Integer)

```crmscript theme={null}
Void SetAssignmentStatus(Integer assignmentStatus)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer assignmentStatus;
thing.SetAssignmentStatus(assignmentStatus);
```

## SetBookingType(Integer)

```crmscript theme={null}
Void SetBookingType(Integer bookingType)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer bookingType;
thing.SetBookingType(bookingType);
```

## SetContactDepartment(String)

```crmscript theme={null}
Void SetContactDepartment(String contactDepartment)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String contactDepartment;
thing.SetContactDepartment(contactDepartment);
```

## SetContactFullName(String)

```crmscript theme={null}
Void SetContactFullName(String contactFullName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String contactFullName;
thing.SetContactFullName(contactFullName);
```

## SetContactId(Integer)

```crmscript theme={null}
Void SetContactId(Integer contactId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer contactId;
thing.SetContactId(contactId);
```

## SetContactName(String)

```crmscript theme={null}
Void SetContactName(String contactName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String contactName;
thing.SetContactName(contactName);
```

## SetEndDate(DateTime)

```crmscript theme={null}
Void SetEndDate(DateTime endDate)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
DateTime endDate;
thing.SetEndDate(endDate);
```

## SetFormalName(String)

```crmscript theme={null}
Void SetFormalName(String formalName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String formalName;
thing.SetFormalName(formalName);
```

## SetInvitationStatus(Integer)

```crmscript theme={null}
Void SetInvitationStatus(Integer invitationStatus)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer invitationStatus;
thing.SetInvitationStatus(invitationStatus);
```

## SetLocation(String)

```crmscript theme={null}
Void SetLocation(String location)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String location;
thing.SetLocation(location);
```

## SetPersonFullName(String)

```crmscript theme={null}
Void SetPersonFullName(String personFullName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String personFullName;
thing.SetPersonFullName(personFullName);
```

## SetPersonId(Integer)

```crmscript theme={null}
Void SetPersonId(Integer personId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer personId;
thing.SetPersonId(personId);
```

## SetProjectId(Integer)

```crmscript theme={null}
Void SetProjectId(Integer projectId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer projectId;
thing.SetProjectId(projectId);
```

## SetProjectName(String)

```crmscript theme={null}
Void SetProjectName(String projectName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String projectName;
thing.SetProjectName(projectName);
```

## SetSaleId(Integer)

```crmscript theme={null}
Void SetSaleId(Integer saleId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
Integer saleId;
thing.SetSaleId(saleId);
```

## SetSaleName(String)

```crmscript theme={null}
Void SetSaleName(String saleName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String saleName;
thing.SetSaleName(saleName);
```

## SetStartTime(DateTime)

```crmscript theme={null}
Void SetStartTime(DateTime startTime)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
DateTime startTime;
thing.SetStartTime(startTime);
```

## SetTaskName(String)

```crmscript theme={null}
Void SetTaskName(String taskName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSAlarmData thing;
String taskName;
thing.SetTaskName(taskName);
```


## Related topics

- [NSMultiAlarmData](/en/automation/crmscript/reference/CRMScript.NetServer.NSMultiAlarmData.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [SuperOffice.WebApi.Data.AlarmData](/en/api/reference/webapi/SuperOffice.WebApi.Data.AlarmData.md)
- [SuperOffice.WebApi.Data.MultiAlarmData](/en/api/reference/webapi/SuperOffice.WebApi.Data.MultiAlarmData.md)
- [Get Alarms](/en/api/reference/restful/agent/appointment_agent/get-alarms.md)
- [Set alarm for follow-up](/en/diary/learn/set-alarm.md)