> ## 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.

# NSAppointmentSyncData

> Carrier object for AppointmentSyncData.

Carrier object for AppointmentSyncData.

## Constructors

### NSAppointmentSyncData()

```crmscript theme={null}
NSAppointmentSyncData
```

Initializes a new instance of the NSAppointmentSyncData class.

## Methods

## GetAlarmTime()

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

**Returns:** [CRMScript.Global.DateTime](CRMScript.Global.DateTime) - Date and time at which to show alarm.

**Example:**

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

## GetAppointmentId()

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

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

**Example:**

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

## GetAppointmentText()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The appointment's textbox; holds a descriptive text about the appointment. Filled out by the user.

**Example:**

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

## GetContactDepartment()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The department of the contact connected to the appointment.

**Example:**

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

## GetContactFullName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The entire name of the contact, including department name.

**Example:**

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

## GetContactId()

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

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The contacts identifier.

**Example:**

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

## GetContactName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The contact associated with the appointment.

**Example:**

```crmscript theme={null}
NSAppointmentSyncData 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}
NSAppointmentSyncData thing;
DateTime endDate = thing.GetEndDate();
```

## GetHasAlarm()

```crmscript theme={null}
Bool GetHasAlarm()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Does this appointment have an alarm?

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool hasAlarm = thing.GetHasAlarm();
```

## GetIsAllDay()

```crmscript theme={null}
Bool GetIsAllDay()
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isAllDay = thing.GetIsAllDay();
```

## GetIsAssignment()

```crmscript theme={null}
Bool GetIsAssignment()
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isAssignment = thing.GetIsAssignment();
```

## GetIsBusy()

```crmscript theme={null}
Bool GetIsBusy()
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isBusy = thing.GetIsBusy();
```

## GetIsCompleted()

```crmscript theme={null}
Bool GetIsCompleted()
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isCompleted = thing.GetIsCompleted();
```

## GetIsInvitation()

```crmscript theme={null}
Bool GetIsInvitation()
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isInvitation = thing.GetIsInvitation();
```

## GetIsTentative()

```crmscript theme={null}
Bool GetIsTentative()
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isTentative = thing.GetIsTentative();
```

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

## GetParticipants()

```crmscript theme={null}
NSParticipantSyncData[] GetParticipants()
```

**Returns:** [CRMScript.NetServer.NSParticipantSyncData](CRMScript.NetServer.NSParticipantSyncData)\[]

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
NSParticipantSyncData[] participants = thing.GetParticipants();
```

## GetPersonFormalName()

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

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
String personFormalName = thing.GetPersonFormalName();
```

## GetPersonFullName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The full name of the person this appointment belongs to.

**Example:**

```crmscript theme={null}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData thing;
Integer projectId = thing.GetProjectId();
```

## GetProjectName()

Project name

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

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData 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}
NSAppointmentSyncData thing;
Integer saleId = thing.GetSaleId();
```

## GetSaleName()

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

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Sale heading (short description?).

**Example:**

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

## GetStartDate()

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

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
DateTime startDate = thing.GetStartDate();
```

## GetTaskName()

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

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData thing;
String appointmentText;
thing.SetAppointmentText(appointmentText);
```

## SetContactDepartment(String)

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

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData thing;
DateTime endDate;
thing.SetEndDate(endDate);
```

## SetHasAlarm(Bool)

```crmscript theme={null}
Void SetHasAlarm(Bool hasAlarm)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool hasAlarm;
thing.SetHasAlarm(hasAlarm);
```

## SetIsAllDay(Bool)

```crmscript theme={null}
Void SetIsAllDay(Bool isAllDay)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isAllDay;
thing.SetIsAllDay(isAllDay);
```

## SetIsAssignment(Bool)

```crmscript theme={null}
Void SetIsAssignment(Bool isAssignment)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isAssignment;
thing.SetIsAssignment(isAssignment);
```

## SetIsBusy(Bool)

```crmscript theme={null}
Void SetIsBusy(Bool isBusy)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isBusy;
thing.SetIsBusy(isBusy);
```

## SetIsCompleted(Bool)

```crmscript theme={null}
Void SetIsCompleted(Bool isCompleted)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isCompleted;
thing.SetIsCompleted(isCompleted);
```

## SetIsInvitation(Bool)

```crmscript theme={null}
Void SetIsInvitation(Bool isInvitation)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isInvitation;
thing.SetIsInvitation(isInvitation);
```

## SetIsTentative(Bool)

```crmscript theme={null}
Void SetIsTentative(Bool isTentative)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
Bool isTentative;
thing.SetIsTentative(isTentative);
```

## SetLocation(String)

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

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

**Example:**

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

## SetParticipants(NSParticipantSyncData\[])

```crmscript theme={null}
Void SetParticipants(NSParticipantSyncData[] participants)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
NSParticipantSyncData[] participants;
thing.SetParticipants(participants);
```

## SetPersonFormalName(String)

```crmscript theme={null}
Void SetPersonFormalName(String personFormalName)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
String personFormalName;
thing.SetPersonFormalName(personFormalName);
```

## SetPersonFullName(String)

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

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData 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}
NSAppointmentSyncData thing;
String saleName;
thing.SetSaleName(saleName);
```

## SetStartDate(DateTime)

```crmscript theme={null}
Void SetStartDate(DateTime startDate)
```

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

**Example:**

```crmscript theme={null}
NSAppointmentSyncData thing;
DateTime startDate;
thing.SetStartDate(startDate);
```

## SetTaskName(String)

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

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

**Example:**

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


## Related topics

- [NSAppointmentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentAgent.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [SuperOffice.WebApi.Data.AppointmentSyncData](/en/api/reference/webapi/SuperOffice.WebApi.Data.AppointmentSyncData.md)
- [SuperOffice.WebApi.Data.Appointment GetMySyncAppointmentsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Appointment_GetMySyncAppointmentsRequest.md)
- [Get My Sync Appointments](/en/api/reference/restful/agent/appointment_agent/get-my-sync-appointments.md)
- [NSParticipantSyncData](/en/automation/crmscript/reference/CRMScript.NetServer.NSParticipantSyncData.md)