Class NSAppointmentAgent

NSAppointmentAgent()

Collection of all services that works with Appointment data.

Declaration

NSAppointmentAgent

NSAppointmentAgent agent;
agent.callMethod(arg1, arg2);

Accept(Integer,Integer)

Accepts an appointment invitation.

Declaration

Void Accept(Integer appointmentId, Integer updateMode)

NSAppointmentAgent agent;
Integer appointmentId;
Integer updateMode;
agent.Accept(appointmentId, updateMode);

Parameters

Returns

AcceptRejected(Integer,Integer)

Accepts that an invited participant has rejected your invitation or assignment.

Declaration

NSAppointmentEntity AcceptRejected(Integer appointmentId, Integer updateMode)

NSAppointmentAgent agent;
Integer appointmentId;
Integer updateMode;
NSAppointmentEntity res = agent.AcceptRejected(appointmentId, updateMode);

Parameters

Returns

AcceptWithEmailConfirmation(Integer,Integer)

Accepts an appointment invitation and sends an email confirmation to the meeting organizer.

Declaration

Void AcceptWithEmailConfirmation(Integer appointmentId, Integer updateMode)

NSAppointmentAgent agent;
Integer appointmentId;
Integer updateMode;
agent.AcceptWithEmailConfirmation(appointmentId, updateMode);

Parameters

Returns

AcceptWithSmtpEmailConfirmation(Integer,Integer)

Accepts an appointment invitation and sends an email confirmation to the meeting organizer.

Declaration

Void AcceptWithSmtpEmailConfirmation(Integer appointmentId, Integer updateMode, NSEMailConnectionInfo smtpEMailConnectionInfo)

NSAppointmentAgent agent;
Integer appointmentId;
Integer updateMode;
NSEMailConnectionInfo smtpEMailConnectionInfo;
agent.AcceptWithSmtpEmailConfirmation(appointmentId, updateMode, smtpEMailConnectionInfo);

Parameters

Returns

AssignTo(Integer,Integer)

Assigns an appointment to another person.

Declaration

NSAppointmentEntity AssignTo(Integer appointmentId, ParticipantInfo participant, Integer updateMode)

NSAppointmentAgent agent;
Integer appointmentId;
ParticipantInfo participant;
Integer updateMode;
NSAppointmentEntity res = agent.AssignTo(appointmentId, participant, updateMode);

Parameters

Returns

CalculateDays()

Calculates the set of dates that represents a recurrence pattern. Adds conflict information to each date.

Declaration

NSRecurrenceInfo CalculateDays(NSAppointmentEntity appointmentEntity)

Parameters

Returns

CanAssignToProjectMember(Integer,Integer)

Declaration

Bool CanAssignToProjectMember(Integer projectId, Integer suggestedAppointmentId)

Parameters

Returns

CleanUpBookingDeleted(Integer[])

Deletes all appointments(within the appointmentIds array) with status BookingDeleted.

Declaration

Integer CleanUpBookingDeleted(Integer[] appointmentIds)

Parameters

Returns

CleanUpRecurringBookingDeleted()

Deletes all appointments with status BookingDeleted and for logged-in user.

Declaration

Integer CleanUpRecurringBookingDeleted()

Returns

CreateAndAccept(Integer,Integer)

Creates an appointment from an emailItem invitation and accepting it.

Declaration

Void CreateAndAccept(Integer emailItemId, Integer updateMode)

Parameters

Returns

CreateAndAcceptWithEmailConfirmation(Integer,Integer)

Creates an appointment from an emailItem invitation and accepting it with email confirmation to the meeting organizer.

Declaration

Void CreateAndAcceptWithEmailConfirmation(Integer emailItemId, Integer updateMode)

Parameters

Returns

CreateAppointmentForUID(String)

Creates an invitation record and an appointment with a given UID to reserve it if the UID is unused, otherwise null.

Declaration

NSAppointmentEntity CreateAppointmentForUID(NSAppointmentEntity appointmentEntity, String uID)

NSAppointmentAgent agent;
NSAppointmentEntity appointmentEntity;
String uID;
NSAppointmentEntity res = agent.CreateAppointmentForUID(appointmentEntity, uID);

Parameters

Returns

CreateDefaultAppointmentEntity()

Sets default values into a new NSAppointmentEntity.

Declaration

NSAppointmentEntity CreateDefaultAppointmentEntity()

NSAppointmentAgent agent;
NSAppointmentEntity thing = agent.CreateDefaultAppointmentEntity();
thing = agent.SaveAppointmentEntity(thing);

Returns

CreateDefaultAppointmentEntityByType(Integer)

Creates an NSAppointmentEntity populated with the default values for the specific type.

Declaration

NSAppointmentEntity CreateDefaultAppointmentEntityByType(Integer type)

NSAppointmentAgent agent;
Integer type;
NSAppointmentEntity res = agent.CreateDefaultAppointmentEntityByType(type);

Parameters

Returns

CreateDefaultAppointmentEntityByTypeAndAssociate(Integer,Integer)

Creates an NSAppointmentEntity populated with the default values for the specific type and owner.

Declaration

NSAppointmentEntity CreateDefaultAppointmentEntityByTypeAndAssociate(Integer type, Integer associateId)

NSAppointmentAgent agent;
Integer type;
Integer associateId;
NSAppointmentEntity res = agent.CreateDefaultAppointmentEntityByTypeAndAssociate(type, associateId);

Parameters

Returns

CreateDefaultAppointmentEntityFromProjectSuggestion(Integer,Integer,Bool,Integer)

Declaration

NSAppointmentEntity CreateDefaultAppointmentEntityFromProjectSuggestion(Integer suggestedAppointmentId, Integer projectId, Bool createNow, Integer ownerId)

Parameters

Returns

CreateDefaultAppointmentEntityFromSaleSuggestion(Integer,Integer,Bool,Integer)

Creates an appointment based on a suggested appointment.

Declaration

NSAppointmentEntity CreateDefaultAppointmentEntityFromSaleSuggestion(Integer suggestedAppointmentId, Integer saleId, Bool createNow, Integer ownerId)

NSAppointmentAgent agent;
Integer suggestedAppointmentId;
Integer saleId;
Bool createNow;
Integer ownerId;
NSAppointmentEntity res = agent.CreateDefaultAppointmentEntityFromSaleSuggestion(suggestedAppointmentId, saleId, createNow, ownerId);

Parameters

Returns

CreateDefaultRecurrence()

Creates an NSRecurrenceInfo object populated with the default values for the specific type.

Declaration

NSRecurrenceInfo CreateDefaultRecurrence()

NSAppointmentAgent agent;
NSRecurrenceInfo res = agent.CreateDefaultRecurrence();

Returns

CreateDefaultRecurrenceByDate()

Creates an NSRecurrenceInfo object populated with the default values for the specific type.

Declaration

NSRecurrenceInfo CreateDefaultRecurrenceByDate(DateTime startDate)

Parameters

Returns

CreateDefaultReOpenAppointment(Integer)

A re-open appointment should be created as a reminder to re-open the sale at a certain date with information regarding the stalled sale.

Declaration

NSAppointmentEntity CreateDefaultReOpenAppointment(Integer saleId)

NSAppointmentAgent agent;
Integer saleId;
NSAppointmentEntity res = agent.CreateDefaultReOpenAppointment(saleId);

Parameters

Returns

CreateDefaultSuggestedAppointmentEntity()

Sets default values into a new NSSuggestedAppointmentEntity.

Declaration

NSSuggestedAppointmentEntity CreateDefaultSuggestedAppointmentEntity()

NSAppointmentAgent agent;
NSSuggestedAppointmentEntity thing = agent.CreateDefaultSuggestedAppointmentEntity();
thing = agent.SaveSuggestedAppointmentEntity(thing);

Returns

CreateDefaultTaskListItem()

Sets default values into a new NSTaskListItem.

Declaration

NSTaskListItem CreateDefaultTaskListItem()

NSAppointmentAgent agent;
NSTaskListItem thing = agent.CreateDefaultTaskListItem();
thing = agent.SaveTaskListItem(thing);

Returns

DeclineInvitationFromEmailItem(Integer,String)

Declining an appointment invitation where no tentative appointments have been created.

Declaration

Void DeclineInvitationFromEmailItem(Integer emailItemId, String rejectReason)

Parameters

Returns

Delete(Integer,Integer,Bool)

Deletes a booking

Declaration

Void Delete(Integer appointmentId, Integer updateMode, Bool sendEmailToParticipants, NSEMailConnectionInfo smtpEMailConnectionInfo, NSEMailConnectionInfo imapEMailConnectionInfo)

Parameters

Returns

DeleteAppointmentEntity(Integer)

Deletes the NSAppointmentEntity.

Declaration

Void DeleteAppointmentEntity(Integer appointmentEntity)

NSAppointmentAgent agent;
agent.DeleteAppointmentEntity(123);

Parameters

Returns

GenerateLead(Integer,String,String,Integer,String,String,String,String,String,String,String,String)

Adds a sales lead (task) to a contact in SuperOffice. If the contact or person is known, the sales lead is added to the current contact. If not, a new contact is created, with the associate with ownerIdForNewContact as responsible (Our Contact). A relation is created between the contact and the person submitting the lead. Based on wether the person the request is made for is found or not, the following happens: If the person is found, the person, person's contact and sales representative is returned. If neither the person nor the contact is found a new person and contact is created (if sufficient data is supplied), and the person, person's contact and sales representative is returned. If the contact and not the person is found a new person is created on this contact, and the contact, salesrep, and person is returned (if there was enough data to return the person).

Declaration

NSSalesActivity GenerateLead(Integer associateIdForNewContact, String leadDescription, String relation, Integer relationId, String leadContact, String leadPersonFirstname, String leadPersonLastname, String leadPersonEmail, String leadPhoneNumber, String creatorsContact, String creatorsFirstname, String creatorsLastname)

NSAppointmentAgent agent;
Integer associateIdForNewContact;
String leadDescription;
String relation;
Integer relationId;
String leadContact;
String leadPersonFirstname;
String leadPersonLastname;
String leadPersonEmail;
String leadPhoneNumber;
String creatorsContact;
String creatorsFirstname;
String creatorsLastname;
NSSalesActivity res = agent.GenerateLead(associateIdForNewContact, leadDescription, relation, relationId, leadContact, leadPersonFirstname, leadPersonLastname, leadPersonEmail, leadPhoneNumber, creatorsContact, creatorsFirstname, creatorsLastname);

Parameters

Returns

GetActivityInformationListByDatesAndAssociate(Integer)

Gets activity information for one or more days according to the given date interval.

Declaration

NSActivityInformationListItem[] GetActivityInformationListByDatesAndAssociate(DateTime startDate, DateTime endDate, Integer associateId)

NSAppointmentAgent agent;
DateTime startDate;
DateTime endDate;
Integer associateId;
NSActivityInformationListItem[] res = agent.GetActivityInformationListByDatesAndAssociate(startDate, endDate, associateId);

Parameters

Returns

GetAlarms(Bool,Bool,Integer)

Declaration

NSMultiAlarmData GetAlarms(Bool includeInvitations, Bool includeAllAppointments, Integer defaultAlarmLeadTimeInMinutes)

Parameters

Returns

GetAppointment(Integer)

Gets an NSAppointment object.

Declaration

NSAppointment GetAppointment(Integer appointmentId)

NSAppointmentAgent agent;
NSAppointment thing = agent.GetAppointment(123);

Parameters

Returns

GetAppointmentEntity(Integer)

Gets an NSAppointmentEntity object.

Declaration

NSAppointmentEntity GetAppointmentEntity(Integer appointmentEntityId)

NSAppointmentAgent agent;
NSAppointmentEntity thing = agent.GetAppointmentEntity(123);

Parameters

Returns

GetAppointmentFromUID(String)

Gets the appointment that corresponds to the given UID.

Declaration

NSAppointmentEntity GetAppointmentFromUID(String uID)

NSAppointmentAgent agent;
String uID;
NSAppointmentEntity res = agent.GetAppointmentFromUID(uID);

Parameters

Returns

GetAppointmentHaveParticipantsWithEmail(Integer)

Checks if any of the participants is marked to receive emails on this appointment.

Declaration

Bool GetAppointmentHaveParticipantsWithEmail(Integer appointmentId)

NSAppointmentAgent agent;
Integer appointmentId;
Bool res = agent.GetAppointmentHaveParticipantsWithEmail(appointmentId);

Parameters

Returns

GetAppointmentList(Integer[])

Retrieves an array of NSAppointment objects.

Declaration

NSAppointment[] GetAppointmentList()

Integer[] ids;
NSAppointmentAgent agent;
agent.GetAppointmentList(ids);

Parameters

Returns

GetAppointmentRecords(Integer,Integer)

Gets all records involved in a booking and/or recurring appointments.

Declaration

NSAppointment[] GetAppointmentRecords(Integer motherId, Integer recurrenceRuleId)

Parameters

Returns

GetAppointmentsByTaskHeading(Integer)

Returns appointments of a specific appointment task heading.

Declaration

NSAppointment[] GetAppointmentsByTaskHeading(Integer taskHeadingId)

NSAppointmentAgent agent;
Integer taskHeadingId;
NSAppointment[] res = agent.GetAppointmentsByTaskHeading(taskHeadingId);

Parameters

Returns

GetAssociateDiary(Integer,Integer)

Declaration

NSAppointment[] GetAssociateDiary(Integer associateId, DateTime startTime, DateTime endTime, Integer count)

Parameters

Returns

GetAssociatesDiary(Integer[])

Declaration

NSAppointment[] GetAssociatesDiary(Integer[] associateIds, DateTime startTime, DateTime endTime)

Parameters

Returns

GetCanInsertForAssociates(Integer[])

Checks if the current associate can create appointments in the diary of other associates.

Declaration

Bool[] GetCanInsertForAssociates(Integer[] associateIds)

NSAppointmentAgent agent;
Integer[] associateIds;
Bool[] res = agent.GetCanInsertForAssociates(associateIds);

Parameters

Returns

GetContactAppointments(Integer,Integer)

Returns a specified number of appointments within a time range. The appointments belong to the contact specified.

Declaration

NSAppointment[] GetContactAppointments(Integer contactId, DateTime startTime, DateTime endTime, Integer count)

NSAppointmentAgent agent;
Integer contactId;
DateTime startTime;
DateTime endTime;
Integer count;
NSAppointment[] res = agent.GetContactAppointments(contactId, startTime, endTime, count);

Parameters

Returns

GetContactAppointmentsByTask(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the contact specified.

Declaration

NSAppointment[] GetContactAppointmentsByTask(Integer contactId, DateTime startTime, DateTime endTime, Integer count, Integer taskId)

NSAppointmentAgent agent;
Integer contactId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskId;
NSAppointment[] res = agent.GetContactAppointmentsByTask(contactId, startTime, endTime, count, taskId);

Parameters

Returns

GetContactAppointmentsByTaskHeading(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the contact specified.

Declaration

NSAppointment[] GetContactAppointmentsByTaskHeading(Integer contactId, DateTime startTime, DateTime endTime, Integer count, Integer taskHeadingId)

NSAppointmentAgent agent;
Integer contactId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskHeadingId;
NSAppointment[] res = agent.GetContactAppointmentsByTaskHeading(contactId, startTime, endTime, count, taskHeadingId);

Parameters

Returns

GetContactAppointmentsByTasks(Integer,Integer,Integer[])

Returns a specified number of appointments belonging to an array of appointment task types within a time range. The appointments belong to the contact specified.

Declaration

NSAppointment[] GetContactAppointmentsByTasks(Integer contactId, DateTime startTime, DateTime endTime, Integer count, Integer[] taskIds)

NSAppointmentAgent agent;
Integer contactId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer[] taskIds;
NSAppointment[] res = agent.GetContactAppointmentsByTasks(contactId, startTime, endTime, count, taskIds);

Parameters

Returns

GetContactAppointmentsByType(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the contact specified.

Declaration

NSAppointment[] GetContactAppointmentsByType(Integer contactId, DateTime startTime, DateTime endTime, Integer count, Integer appointmentType)

NSAppointmentAgent agent;
Integer contactId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer appointmentType;
NSAppointment[] res = agent.GetContactAppointmentsByType(contactId, startTime, endTime, count, appointmentType);

Parameters

Returns

GetDayInformationListByDatesAndAssociate(Integer)

Gets combined day information (activity + red-letter summary) for one or more days according to the given date interval.

Declaration

NSDayInformationListItem[] GetDayInformationListByDatesAndAssociate(DateTime startDate, DateTime endDate, Integer associateId)

NSAppointmentAgent agent;
DateTime startDate;
DateTime endDate;
Integer associateId;
NSDayInformationListItem[] res = agent.GetDayInformationListByDatesAndAssociate(startDate, endDate, associateId);

Parameters

Returns

GetDiaryByGroup(Integer,Integer,Integer)

Declaration

NSAppointment[] GetDiaryByGroup(Integer groupId, Integer groupType, DateTime startTime, DateTime endTime, Integer count)

Parameters

Returns

GetMyAppointments(Integer)

Returns a specified number of appointments within a time range. The appointments belong to the currently logged-on user.

Declaration

NSAppointment[] GetMyAppointments(DateTime startTime, DateTime endTime, Integer count)

NSAppointmentAgent agent;
DateTime startTime;
DateTime endTime;
Integer count;
NSAppointment[] res = agent.GetMyAppointments(startTime, endTime, count);

Parameters

Returns

GetMyDiary(Integer)

Returns a specified number of appointments within a time range. The appointments belong to the currently logged-on user.

Declaration

NSAppointment[] GetMyDiary(DateTime startTime, DateTime endTime, Integer count)

NSAppointmentAgent agent;
DateTime startTime;
DateTime endTime;
Integer count;
NSAppointment[] res = agent.GetMyDiary(startTime, endTime, count);

Parameters

Returns

GetMyPublishedAppointments()

Gets published appointments from the logged in user.

Declaration

NSAppointment[] GetMyPublishedAppointments()

NSAppointmentAgent agent;
NSAppointment[] res = agent.GetMyPublishedAppointments();

Returns

GetMySyncAppointments()

Returns a specified number of appointments within a time range. The appointments belong to the currently logged-on user.

Declaration

NSAppointmentSyncData[] GetMySyncAppointments(DateTime startTime, DateTime endTime)

NSAppointmentAgent agent;
DateTime startTime;
DateTime endTime;
NSAppointmentSyncData[] res = agent.GetMySyncAppointments(startTime, endTime);

Parameters

Returns

GetMyTasks(Integer)

Returns a specified number of appointments within a time range. The appointments belong to the currently logged-on user.

Declaration

NSAppointment[] GetMyTasks(Integer count)

NSAppointmentAgent agent;
Integer count;
NSAppointment[] res = agent.GetMyTasks(count);

Parameters

Returns

GetNextSuggestedAppointmentBySale(Integer,Integer,Bool)

Gets the next suggested appointment for a given sale (or rather a given sales guide).

Declaration

NSSuggestedAppointment GetNextSuggestedAppointmentBySale(Integer saleId, Integer currentAppointmentId, Bool skipCompleteCheck)

NSAppointmentAgent agent;
Integer saleId;
Integer currentAppointmentId;
Bool skipCompleteCheck;
NSSuggestedAppointment res = agent.GetNextSuggestedAppointmentBySale(saleId, currentAppointmentId, skipCompleteCheck);

Parameters

Returns

GetOrganizerName(Integer)

Looks up the name / email of an event-organizer

Declaration

String GetOrganizerName(Integer motherAppointmentId)

NSAppointmentAgent agent;
Integer motherAppointmentId;
String res = agent.GetOrganizerName(motherAppointmentId);

Parameters

Returns

GetPersonAppointments(Integer,Bool,Integer)

Returns a specified number of appointments within a time range. The appointments belong to the person specified.

Declaration

NSAppointment[] GetPersonAppointments(Integer personId, Bool includeProjectAppointments, DateTime startTime, DateTime endTime, Integer count)

NSAppointmentAgent agent;
Integer personId;
Bool includeProjectAppointments;
DateTime startTime;
DateTime endTime;
Integer count;
NSAppointment[] res = agent.GetPersonAppointments(personId, includeProjectAppointments, startTime, endTime, count);

Parameters

Returns

GetPersonAppointmentsByTask(Integer,Bool,Integer,Integer)

Returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the person specified.

Declaration

NSAppointment[] GetPersonAppointmentsByTask(Integer personId, Bool includeProjectAppointments, DateTime startTime, DateTime endTime, Integer count, Integer taskId)

NSAppointmentAgent agent;
Integer personId;
Bool includeProjectAppointments;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskId;
NSAppointment[] res = agent.GetPersonAppointmentsByTask(personId, includeProjectAppointments, startTime, endTime, count, taskId);

Parameters

Returns

GetPersonAppointmentsByTaskHeading(Integer,Bool,Integer,Integer)

Returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the person specified.

Declaration

NSAppointment[] GetPersonAppointmentsByTaskHeading(Integer personId, Bool includeProjectAppointments, DateTime startTime, DateTime endTime, Integer count, Integer taskHeadingId)

NSAppointmentAgent agent;
Integer personId;
Bool includeProjectAppointments;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskHeadingId;
NSAppointment[] res = agent.GetPersonAppointmentsByTaskHeading(personId, includeProjectAppointments, startTime, endTime, count, taskHeadingId);

Parameters

Returns

GetPersonAppointmentsByTasks(Integer,Bool,Integer,Integer[])

Returns a specified number of appointments from a list of appointment task types within a time range. The appointments belong to the person specified.

Declaration

NSAppointment[] GetPersonAppointmentsByTasks(Integer personId, Bool includeProjectAppointments, DateTime startTime, DateTime endTime, Integer count, Integer[] taskIds)

NSAppointmentAgent agent;
Integer personId;
Bool includeProjectAppointments;
DateTime startTime;
DateTime endTime;
Integer count;
Integer[] taskIds;
NSAppointment[] res = agent.GetPersonAppointmentsByTasks(personId, includeProjectAppointments, startTime, endTime, count, taskIds);

Parameters

Returns

GetPersonAppointmentsByType(Integer,Bool,Integer,Integer)

Returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the person specified.

Declaration

NSAppointment[] GetPersonAppointmentsByType(Integer personId, Bool includeProjectAppointments, DateTime startTime, DateTime endTime, Integer count, Integer appointmentType)

NSAppointmentAgent agent;
Integer personId;
Bool includeProjectAppointments;
DateTime startTime;
DateTime endTime;
Integer count;
Integer appointmentType;
NSAppointment[] res = agent.GetPersonAppointmentsByType(personId, includeProjectAppointments, startTime, endTime, count, appointmentType);

Parameters

Returns

GetPersonDiary(Integer,Integer)

Returns a specified number of appointments within a time range.

Declaration

NSAppointment[] GetPersonDiary(Integer personId, DateTime startTime, DateTime endTime, Integer count)

NSAppointmentAgent agent;
Integer personId;
DateTime startTime;
DateTime endTime;
Integer count;
NSAppointment[] res = agent.GetPersonDiary(personId, startTime, endTime, count);

Parameters

Returns

GetPersonTasks(Integer,Integer)

Returns a specified number of appointments within a time range.

Declaration

NSAppointment[] GetPersonTasks(Integer personId, Integer count)

NSAppointmentAgent agent;
Integer personId;
Integer count;
NSAppointment[] res = agent.GetPersonTasks(personId, count);

Parameters

Returns

GetProjectAppointments(Integer,Integer)

Returns a specified number of appointments within a time range. The appointments belong to the project specified.

Declaration

NSAppointment[] GetProjectAppointments(Integer projectId, DateTime startTime, DateTime endTime, Integer count)

NSAppointmentAgent agent;
Integer projectId;
DateTime startTime;
DateTime endTime;
Integer count;
NSAppointment[] res = agent.GetProjectAppointments(projectId, startTime, endTime, count);

Parameters

Returns

GetProjectAppointmentsByTask(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the project specified.

Declaration

NSAppointment[] GetProjectAppointmentsByTask(Integer projectId, DateTime startTime, DateTime endTime, Integer count, Integer taskId)

NSAppointmentAgent agent;
Integer projectId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskId;
NSAppointment[] res = agent.GetProjectAppointmentsByTask(projectId, startTime, endTime, count, taskId);

Parameters

Returns

GetProjectAppointmentsByTaskHeading(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the project specified.

Declaration

NSAppointment[] GetProjectAppointmentsByTaskHeading(Integer projectId, DateTime startTime, DateTime endTime, Integer count, Integer taskHeadingId)

NSAppointmentAgent agent;
Integer projectId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskHeadingId;
NSAppointment[] res = agent.GetProjectAppointmentsByTaskHeading(projectId, startTime, endTime, count, taskHeadingId);

Parameters

Returns

GetProjectAppointmentsByTasks(Integer,Integer,Integer[])

Returns a specified number of appointments matching the list of appointment task types within a time range. The appointments belong to the project specified.

Declaration

NSAppointment[] GetProjectAppointmentsByTasks(Integer projectId, DateTime startTime, DateTime endTime, Integer count, Integer[] taskIds)

NSAppointmentAgent agent;
Integer projectId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer[] taskIds;
NSAppointment[] res = agent.GetProjectAppointmentsByTasks(projectId, startTime, endTime, count, taskIds);

Parameters

Returns

GetProjectAppointmentsByType(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the project specified.

Declaration

NSAppointment[] GetProjectAppointmentsByType(Integer projectId, DateTime startTime, DateTime endTime, Integer count, Integer appointmentType)

NSAppointmentAgent agent;
Integer projectId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer appointmentType;
NSAppointment[] res = agent.GetProjectAppointmentsByType(projectId, startTime, endTime, count, appointmentType);

Parameters

Returns

GetProjectMemberAppointments(Integer,Integer)

Returns a specified number of appointments within a time range. The appointments belong to the projects where the person specified is member.

Declaration

NSAppointment[] GetProjectMemberAppointments(Integer personId, DateTime startTime, DateTime endTime, Integer count)

NSAppointmentAgent agent;
Integer personId;
DateTime startTime;
DateTime endTime;
Integer count;
NSAppointment[] res = agent.GetProjectMemberAppointments(personId, startTime, endTime, count);

Parameters

Returns

GetProjectMemberAppointmentsByTask(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment task type within a time range. The appointments belong to the projects where the person specified is member.

Declaration

NSAppointment[] GetProjectMemberAppointmentsByTask(Integer personId, DateTime startTime, DateTime endTime, Integer count, Integer taskId)

NSAppointmentAgent agent;
Integer personId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskId;
NSAppointment[] res = agent.GetProjectMemberAppointmentsByTask(personId, startTime, endTime, count, taskId);

Parameters

Returns

GetProjectMemberAppointmentsByTaskHeading(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment task heading within a time range. The appointments belong to the projects where the person specified is member.

Declaration

NSAppointment[] GetProjectMemberAppointmentsByTaskHeading(Integer personId, DateTime startTime, DateTime endTime, Integer count, Integer taskHeadingId)

NSAppointmentAgent agent;
Integer personId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer taskHeadingId;
NSAppointment[] res = agent.GetProjectMemberAppointmentsByTaskHeading(personId, startTime, endTime, count, taskHeadingId);

Parameters

Returns

GetProjectMemberAppointmentsByTasks(Integer,Integer,Integer[])

Returns a specified number of appointments matching a set of appointment task types within a time range. The appointments belong to the projects where the person specified is member.

Declaration

NSAppointment[] GetProjectMemberAppointmentsByTasks(Integer personId, DateTime startTime, DateTime endTime, Integer count, Integer[] taskIds)

NSAppointmentAgent agent;
Integer personId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer[] taskIds;
NSAppointment[] res = agent.GetProjectMemberAppointmentsByTasks(personId, startTime, endTime, count, taskIds);

Parameters

Returns

GetProjectMemberAppointmentsByType(Integer,Integer,Integer)

Returns a specified number of appointments of a specific appointment type within a time range. The appointments belong to the projects where the person specified is member.

Declaration

NSAppointment[] GetProjectMemberAppointmentsByType(Integer personId, DateTime startTime, DateTime endTime, Integer count, Integer appointmentType)

NSAppointmentAgent agent;
Integer personId;
DateTime startTime;
DateTime endTime;
Integer count;
Integer appointmentType;
NSAppointment[] res = agent.GetProjectMemberAppointmentsByType(personId, startTime, endTime, count, appointmentType);

Parameters

Returns

GetPublishedAppointment(Integer)

Gets published appointment by appointment ID.

Declaration

NSAppointment GetPublishedAppointment(Integer appointmentId)

NSAppointmentAgent agent;
Integer appointmentId;
NSAppointment res = agent.GetPublishedAppointment(appointmentId);

Parameters

Returns

GetPublishedAppointments(Integer[])

Gets published appointments by appointment IDs.

Declaration

NSAppointment[] GetPublishedAppointments(Integer[] appointmentIds)

NSAppointmentAgent agent;
Integer[] appointmentIds;
NSAppointment[] res = agent.GetPublishedAppointments(appointmentIds);

Parameters

Returns

GetPublishedProjectAppointments(Integer)

Gets published appointments by project ID.

Declaration

NSAppointment[] GetPublishedProjectAppointments(Integer projectId)

NSAppointmentAgent agent;
Integer projectId;
NSAppointment[] res = agent.GetPublishedProjectAppointments(projectId);

Parameters

Returns

GetRedLetterInformationListByDatesAndAssociate(Integer)

Gets detailed red-letter day information (red-letter summary + individual day texts) for one or more days according to the given date interval.

Declaration

NSRedLetterInformationListItem[] GetRedLetterInformationListByDatesAndAssociate(DateTime startDate, DateTime endDate, Integer associateId)

NSAppointmentAgent agent;
DateTime startDate;
DateTime endDate;
Integer associateId;
NSRedLetterInformationListItem[] res = agent.GetRedLetterInformationListByDatesAndAssociate(startDate, endDate, associateId);

Parameters

Returns

GetSuggestedAppointment(Integer)

Gets an NSSuggestedAppointment object.

Declaration

NSSuggestedAppointment GetSuggestedAppointment(Integer suggestedAppointmentId)

NSAppointmentAgent agent;
NSSuggestedAppointment thing = agent.GetSuggestedAppointment(123);

Parameters

Returns

GetSuggestedAppointmentEntity(Integer)

Gets an NSSuggestedAppointmentEntity object.

Declaration

NSSuggestedAppointmentEntity GetSuggestedAppointmentEntity(Integer suggestedAppointmentEntityId)

NSAppointmentAgent agent;
NSSuggestedAppointmentEntity thing = agent.GetSuggestedAppointmentEntity(123);

Parameters

Returns

GetTaskListItem(Integer)

Gets an NSTaskListItem object.

Declaration

NSTaskListItem GetTaskListItem(Integer taskListItemId)

NSAppointmentAgent agent;
NSTaskListItem thing = agent.GetTaskListItem(123);

Parameters

Returns

GetTaskListItems(Bool)

Gets all takslist items

Declaration

NSTaskListItem[] GetTaskListItems(Bool includeDeleted)

NSAppointmentAgent agent;
Bool includeDeleted;
NSTaskListItem[] res = agent.GetTaskListItems(includeDeleted);

Parameters

Returns

GetUIDFromAppointmentId(Integer,Bool)

Gets the UID associated with the appointment id in the Invitation table.

Declaration

String GetUIDFromAppointmentId(Integer appointmentId, Bool useMotherId)

NSAppointmentAgent agent;
Integer appointmentId;
Bool useMotherId;
String res = agent.GetUIDFromAppointmentId(appointmentId, useMotherId);

Parameters

Returns

Move(Integer,Integer)

Moving a booking to another start time.

Declaration

NSAppointmentEntity Move(Integer appointmentId, DateTime newStartTime, Integer updateMode)

NSAppointmentAgent agent;
Integer appointmentId;
DateTime newStartTime;
Integer updateMode;
NSAppointmentEntity res = agent.Move(appointmentId, newStartTime, updateMode);

Parameters

Returns

Reject(Integer,String,Integer)

Rejecting an appointment invitation

Declaration

Void Reject(Integer appointmentId, String rejectReason, Integer updateMode)

NSAppointmentAgent agent;
Integer appointmentId;
String rejectReason;
Integer updateMode;
agent.Reject(appointmentId, rejectReason, updateMode);

Parameters

Returns

RejectWithEmailConfirmation(Integer,String,Integer)

Rejecting an appointment invitation and send an email confirmation to the meeting organizer.

Declaration

Void RejectWithEmailConfirmation(Integer appointmentId, String rejectReason, Integer updateMode)

NSAppointmentAgent agent;
Integer appointmentId;
String rejectReason;
Integer updateMode;
agent.RejectWithEmailConfirmation(appointmentId, rejectReason, updateMode);

Parameters

Returns

RejectWithSmtpEmailConfirmation(Integer,String,Integer)

Rejecting an appointment invitation and send an email confirmation to the meeting organizer.

Declaration

Void RejectWithSmtpEmailConfirmation(Integer appointmentId, String rejectReason, Integer updateMode, NSEMailConnectionInfo smtpEMailConnectionInfo)

NSAppointmentAgent agent;
Integer appointmentId;
String rejectReason;
Integer updateMode;
NSEMailConnectionInfo smtpEMailConnectionInfo;
agent.RejectWithSmtpEmailConfirmation(appointmentId, rejectReason, updateMode, smtpEMailConnectionInfo);

Parameters

Returns

RequestForInfo(Integer,String,String,String,String,String,String,String)

Submits a request for information. The request is added to the task list of the user that is responsible for this contact. Based on wether the person the request is made for is found or not, the following happens: If the person is found, the person, person's contact and sales representative is returned. If neither the person nor the contact is found a new person and contact is created (if sufficient data is supplied), and the person, person's contact and sales representative is returned. If the contact and not the person is found a new person is created on this contact, and the contact, salesrep, and person is returned (if there was enough data to return the person). If more than one contact is found a list of contacts is returned.

Declaration

NSSalesActivity RequestForInfo(Integer associateIdForNewContact, String channel, String regarding, String contactName, String personFirstname, String personLastname, String emailAddress, String phoneNumber)

NSAppointmentAgent agent;
Integer associateIdForNewContact;
String channel;
String regarding;
String contactName;
String personFirstname;
String personLastname;
String emailAddress;
String phoneNumber;
NSSalesActivity res = agent.RequestForInfo(associateIdForNewContact, channel, regarding, contactName, personFirstname, personLastname, emailAddress, phoneNumber);

Parameters

Returns

Save(Integer,Bool)

Saving a booking.

Declaration

NSAppointmentEntity Save(NSAppointmentEntity appointmentEntity, Integer updateMode, Bool sendEmailToParticipants, NSEMailConnectionInfo smtpEMailConnectionInfo, NSEMailConnectionInfo imapEMailConnectionInfo)

NSAppointmentAgent agent;
NSAppointmentEntity appointmentEntity;
Integer updateMode;
Bool sendEmailToParticipants;
NSEMailConnectionInfo smtpEMailConnectionInfo;
NSEMailConnectionInfo imapEMailConnectionInfo;
NSAppointmentEntity res = agent.Save(appointmentEntity, updateMode, sendEmailToParticipants, smtpEMailConnectionInfo, imapEMailConnectionInfo);

Parameters

Returns

SaveAppointmentEntity(NSAppointmentEntity)

Saves an appointmentUpdates the existing NSAppointmentEntity or creates a new NSAppointmentEntity if the ID parameter is 0.

Declaration

NSAppointmentEntity SaveAppointmentEntity(NSAppointmentEntity appointmentEntity)

NSAppointment  agent;
NSAppointmentEntity thing = agent.CreateDefaultAppointmentEntity();
thing = agent.SaveAppointmentEntity(thing);

Parameters

Returns

SaveSuggestedAppointmentEntity(NSSuggestedAppointmentEntity)

Updates the existing NSSuggestedAppointmentEntity or creates a new NSSuggestedAppointmentEntity if the id parameter is 0

Declaration

NSSuggestedAppointmentEntity SaveSuggestedAppointmentEntity(NSSuggestedAppointmentEntity suggestedAppointmentEntity)

NSAppointment  agent;
NSSuggestedAppointmentEntity thing = agent.CreateDefaultSuggestedAppointmentEntity();
thing = agent.SaveSuggestedAppointmentEntity(thing);

Parameters

Returns

SaveTaskListItem(NSTaskListItem)

Updates the existing NSTaskListItem or creates a new NSTaskListItem if the ID parameter is 0.

Declaration

NSTaskListItem SaveTaskListItem(NSTaskListItem taskListItem)

NSAppointment  agent;
NSTaskListItem thing = agent.CreateDefaultTaskListItem();
thing = agent.SaveTaskListItem(thing);

Parameters

Returns

SetActivityStatus(String[],Integer)

Sets the completed status for an array of activities. The changes are saved immediately.

Declaration

Void SetActivityStatus(String[] activityIdentifier, Integer activityStatus)

Parameters

Returns

SetSeen(Integer,Integer)

Sets an appointment invitation to seen.

Declaration

Void SetSeen(Integer appointmentId, Integer updateMode)

Parameters

Returns

ToggleActivities(String[])

Toggles the completed status for an array of activities.

Declaration

Integer ToggleActivities(String[] activityIdentifier)

NSAppointmentAgent agent;
String[] activityIdentifier;
Integer res = agent.ToggleActivities(activityIdentifier);

Parameters

Returns

ToggleActivity(String)

Toggles the completed status for an activity. The changes are saved immediately.

Declaration

Integer ToggleActivity(String activityIdentifier)

NSAppointmentAgent agent;
String activityIdentifier;
Integer res = agent.ToggleActivity(activityIdentifier);

Parameters

Returns

ToggleAndSetActivities(String[])

Toggles the first activity and sets the rest of the activities to the result of the first toggle.

Declaration

String[] ToggleAndSetActivities(String[] activityIdentifiers)

NSAppointmentAgent agent;
String[] activityIdentifiers;
String[] res = agent.ToggleAndSetActivities(activityIdentifiers);

Parameters

Returns

ToggleAppointmentStatus(Integer)

Sets an appointment's status to Completed if the appointment had a different status, or sets the status to started if already set to completed.

Declaration

Integer ToggleAppointmentStatus(Integer appointmentId)

NSAppointmentAgent agent;
Integer appointmentId;
Integer res = agent.ToggleAppointmentStatus(appointmentId);

Parameters

Returns

UpdateAppointment(Integer,Integer,Integer,Integer)

Updates an appointment record.

Declaration

NSAppointment UpdateAppointment(Integer id, DateTime startTime, DateTime endTime, Integer status, Integer type, Integer associateId)

Parameters

Returns

UpdateAppointmentFromIcsResponse(String)

Updates the attendance to an appointment based on incoming ICS RSVPs.

Declaration

Bool UpdateAppointmentFromIcsResponse(String emailAddress, NSStream icsData)

NSAppointmentAgent agent;
String emailAddress;
NSStream icsData;
Bool res = agent.UpdateAppointmentFromIcsResponse(emailAddress, icsData);

Parameters

Returns

ValidateAppointmentEntity()

Checks that entity is ready for saving.

Declaration

Map ValidateAppointmentEntity(NSAppointmentEntity appointmentEntity)

NSAppointmentAgent agent;
NSAppointmentEntity appointmentEntity;
Map res = agent.ValidateAppointmentEntity(appointmentEntity);

Parameters

Returns

ValidateDays()

Validates the set of dates to calculate any conflicts.

Declaration

NSRecurrenceDate[] ValidateDays(NSAppointmentEntity appointmentEntity, DateTime[] dates)

NSAppointmentAgent agent;
NSAppointmentEntity appointmentEntity;
DateTime[] dates;
NSRecurrenceDate[] res = agent.ValidateDays(appointmentEntity, dates);

Parameters

Returns

WillSendEmail()

Returns true if the changes will trigger email sending on Save, so you can inform the user.

Declaration

Bool WillSendEmail(NSAppointmentEntity appointment)

NSAppointmentAgent agent;
NSAppointmentEntity appointment;
Bool res = agent.WillSendEmail(appointment);

Parameters

Returns