IAppointment Interface |
Namespace: SuperOffice.COM.SuperOfficeDB
The IAppointment type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | ActiveDate | ActiveDate is DoBy until the appointment is completed, then ActiveDate = Done date
Activedate is the same as the DoBy date until the appointment is completed, then the ActiveDate is changed to Done date. |
![]() ![]() | ActiveLinks | ActiveLinks - Number of active links to documents, projects, Urls, appointments, sales, contacts, persons, selections |
![]() ![]() | ActivityLinks | The ActivityLinks attached to this appointment. Add or remove links on this object. |
![]() ![]() | Alarm | Has Alarm?
Alarm gives you a notification before the start time of the appointment |
![]() ![]() | AlarmOffset | Alarm - minutes before
Alarm gives you a notification before the start time of the appointment
AlarmOffset is the number of minutes before the appointments alarm is supposed to "fire" |
![]() ![]() | AllDayEvent | AllDayEvent - Is this an all day event: FALSE = No, TRUE = Yes. |
![]() ![]() | AssignedBy | AssignedBy - Who (last) assigned this appointment to associate_id? |
![]() ![]() | Associate | The owner of this appointment.
The associate whose diary/checklist the appointment is in |
![]() ![]() | AutoSaveOnChangeIdentity | Should the model save on IdentityChanged? |
![]() ![]() | AutoSaveOnFlush | Should the model save on flush cache? |
![]() | CautionWarning | Get caution warning number |
![]() ![]() | Changed | has record been changed since read?
If the appointment has been modified since it was loaded, this will return false |
![]() ![]() | ColorIndex | ColorIndex - used in Japan
From CRM 5 Release 5.5 you may set different colour schema on the different types of appointments. |
![]() ![]() | Completed | Completed checkbox
An appointment that has not been completed yet will always be shown in the owning associates diary. If the do by date has passed, it will be in the checklist even if it had a time stamp. See the database manual for more information regarding appointments shown in checklist or diary. |
![]() ![]() | Contact | The Contact for this appointment
It may also be 0 if no contact is associated with the appointment |
![]() ![]() | CreatedAssociate | The user that created the object
The associate that first created the appointment |
![]() ![]() | CreatedDate | The date the object was saved to the database.
The date and time the appointment was first created. |
![]() ![]() | Description | Appointment text
holds a descriptive text about the appointment. Filled out by the user. |
![]() ![]() | DoBy | deadline for todo, starttime for appointment
The date and time that the appointment is supposed to be completed. |
![]() | Document | |
![]() ![]() | DocumentLink | OBSOLETE - use ActivityLinks instead.
Obsolete
Obsolete |
![]() ![]() | Done | date+time when task was completed.
The date and time that the appointment was actually completed. |
![]() ![]() | Duration | duration of appointment - in minutes
Duration (in minutes) of the appointment. |
![]() ![]() | EmailId | EmailId - If invitation and status changes should be mailed, this is the ID of the email address used. |
![]() ![]() | EndDate | EndDate = DoBy + duration
EndDate is the same as DoBy + duration. |
![]() | ExternalFieldChanged | have external fields been changed? |
![]() ![]() | ForeignKey | ForeignKey
Get the foreign key values for this appointment |
![]() ![]() | FreeBusy | FreeBusy - What kind of time is this: 0 = Busy, 1 = Free. |
![]() ![]() | Group | Primary User Group of owning associate. Set implicitly by AssociateId. |
![]() ![]() | GroupID | The owner's primary user group id
The usergroup_id the owner of the appointment object belongs to. |
![]() ![]() | Identity | The primary key on the primary table. Is zero for new objects. Is set when an object is saved.
The appointments database unique internal identity. |
![]() ![]() | InvitedPerson | The person who is invited by the appointment
If the appointment is a booking, the invited persons may be your associates, but you are also able to invite contact persons from other companies to join your meeting. They do not receive an invitation, unless you send them one by email, but you can see in the appointment that persons other than your associates have been invited to a meeting. Each invited person will have an appointment slave record. |
![]() ![]() | IsAvailable | is record available in db?
It's useful to check if an appointment actually exists before adding new properties to it. |
![]() | IsFavourite | Add/Remove this appointment from my favourites |
![]() ![]() | IsRecurring | Is this a recurring appointment. |
![]() ![]() | IsRequiredFilled | Are all the required fields filled out? Can we save the record?
Checks if all properties that are required in this model is filled |
![]() ![]() | IsValid | does the record exist?
To save time, we dont load a record into buffer before one of its properties is asked for. This checks if the requested record is available in buffer |
![]() ![]() | LeadTime | LeadTime |
![]() | LocalizedCautionWarning | Localized caution warning text |
![]() ![]() | Location | Location - Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want. |
![]() ![]() | Mother | Mother appointment. Used for linking invitations to the main appointment.
The mother property is used if the appointment is a booking. If this is a normal appointment, the mother will be 0. If this appointment was the original appointment, made by the associate that wants to invite others to a meeting, the id in mother will be the same as the appointments identity. If this appointment is a daughter appointment, generated from someone inviting you to a meeting, the id here will be the same as the mother appointments identity |
![]() ![]() | Person | The Person for this appointment
Must be a contact person registered on the current company. This does not mean however that a person is required |
![]() ![]() | Priority | Priority - list item - table enTablePriority=79
Its possible to give appointments different priorities. All the different priority types are saved in the priority table, and edited from the Admin. Client. An appointment does not require a priority |
![]() ![]() | Private | Visible for who? Public/Private 0=public,1=private,2=group
The confidentiality of appointments is shown as different types of private on the appointment |
![]() ![]() | PrivateToGroup | The group this appointment is visible for when Private = group.
The confidentiality of appointments is shown as different types of private on the appointment |
![]() ![]() | Project | Project for this appointment
An appointment may also be connected to a project, so you see the appointment both on the company card, and on the project card. This does not mean however that a project is required. |
![]() ![]() | PublishType | Publish type for this appointment: 0 = enPublishTypeUndefined, 1 = enPublishTypeExternal. |
![]() ![]() | Recurrence | Get the recurrence object for this appointment. If this is not a recurring event the object gets default zero values. |
![]() ![]() | RecurrenceRuleId | RecurrenceRuleId - Id for the recurrence rule for recurring appointments, otherwise 0. |
![]() ![]() | RejectCounter | RejectCounter - How many invitees have rejected this appointment. |
![]() ![]() | RejectReason | RejectReason - Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here. |
![]() | Sale | Sale for this appointment |
![]() ![]() | Sentry | Sentry settings for this object. Lets you find out your read/write access to the object. |
![]() ![]() | Status | Status for the appointment, for example: 1 = not started/accepted, 3 = completed, 5 = booking, 9 = declined.
The different statuses an appointment may have, from a fixed predefined list. See the database manual for an updated list of status types |
![]() | SuggestedAppointmentId | Gets the suggested appointment id |
![]() ![]() | Task | Appointment task type - list item - table enTableTask=67
Task comprises the different types of activities, like Phone call, Meeting and so on |
![]() ![]() | TimeZoneLocationId | Gets the Timezone location id this appointment was stored under |
![]() ![]() | Type | 1=diary,2=checklist,6=invite
The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if its a document |
![]() ![]() | UDef | UDef - The user-defined fields on the appointment. |
![]() ![]() | UpdatedAssociate | The last user to modify the object
If the appointment has never been updated, this will return 0 |
![]() ![]() | UpdatedDate | The date of the most recent update.
If the appointment has never been updated, this will return 0; formatted as a SuperOffice date (see the database manual), this will return 01.01.1970 |
![]() ![]() | UpdateMode | How will the recurring events be updated? For example: 0 = enNotSet, 1 = enOnlyThis, 2 = enThisAndForward... |
![]() | ValidationMessage | get validation message, if empty model will think it is ok to save |
Name | Description | |
---|---|---|
![]() ![]() | AcceptInvitation | Accept or reject this invitation: 0 = Reject, 1 = Accept. |
![]() | AddParticipant | |
![]() ![]() | AssignTo | Assign appointment to an associate, from another associate (default from current associate) |
![]() ![]() | CancelChanges | Undo any changes made since the object was loaded.
If you made changes to the model that you dont want to be saved to the database, call the CancelChanges method |
![]() ![]() | ChangeIdentity | Loads a different record into the object. Causes changes to the existing object to be saved first.
Saves the changes made to the appointment model to the database. The last thing you do to an object if you want the changes you made to be saved. The ChangeIdentity method calls the save method first. |
![]() | Clone | Clone this appointment |
![]() ![]() | Delete | Delete the object from the database. May throw an error if you are not allowed to delete the object.
Deletes the specified appointment model from the database |
![]() ![]() | GetNoOfParticipants | Number of participants for this booking. |
![]() ![]() | GetParticipants | Get all participants of the required type for this appointment. Returns an SOAssociates or an SOPersons list depending on the type. |
![]() ![]() | HasConflict | Has this appointment(booking) a time conflict? 0 = enResponseReject, 1 = enResponseAccept |
![]() ![]() | InsertAppointmentPerson | If the main appointment has a person, insert the person as a participant on the booking. |
![]() | IsSuggestedItem | Is this appointment used as a suggested appointment? |
![]() | RemoveParticipant | |
![]() ![]() | Save | Persist the object to the database. May throw an error if you are not allowed to save changes to the object.
Saves the changes you made to the appointment model to the database, does not return the new data from the database |
![]() ![]() | SetDefaults | Populate the object with default values, such as setting the owner to the current user.
The user is able to define their own default types, priority and duration under View – Preference in the CRM 5 clients. Calling the setDefaults method will set these values on the appointment. |
![]() ![]() | SetDefaultsCall | SetDefaults for a phone call appointment. Has short duration. Starts now.
The user is able to define their own default types, priority and duration under View – Preference in the CRM 5 clients. Calling the setDefaults method will set these values on the appointment.
The user is able to define their own default types, priority and duration under View Preference in the CRM 5 clients. Calling the SetDefaultsCall method will set these values on the appointment. |
![]() ![]() | SetDefaultsToDo | SetDefaults for a ToDo appointment. Has no start time.
The user is able to define their own default types, priority and duration under View – Preference in the CRM 5 clients. Calling the setDefaults method will set these values on the appointment.
The user is able to define their own default types, priority and duration under View Preference in the CRM 5 clients. Calling the SetDefaultsToDo method will set these values on the appointment as long as it is of type = ToDo |
![]() | SuggestedItemId | Get the suggested item id |