Click or drag to resize

IAppointment Interface

Appointment object - represents to-do's, follow-ups, phone-calls.

Namespace:  SuperOffice.COM.Application
Assembly:  SOCRM.Interop (in SOCRM.Interop.dll) Version: 8.0.0.0
Syntax
public interface IAppointment : IModelBase

The IAppointment type exposes the following members.

Properties
  NameDescription
Public propertyActiveDate
ActiveDate is DoBy until the appointment is completed, then ActiveDate = Done date
Public propertyActiveLinks
ActiveLinks - Number of active links to documents, projects, Urls, appointments, sales, contacts, persons, selections
Public propertyActivityLinks
The ActivityLinks attached to this appointment. Add or remove links on this object.
Public propertyAlarm
Has Alarm?
Public propertyAlarmOffset
Alarm - minutes before
Public propertyAllDayEvent
AllDayEvent - Is this an all day event: FALSE = No, TRUE = Yes.
Public propertyAssignedBy
AssignedBy - Who (last) assigned this appointment to associate_id?
Public propertyAssociate
The owner of this appointment.
Public propertyAutoSaveOnChangeIdentity
Should the model save on IdentityChanged?
Public propertyAutoSaveOnFlush
Should the model save on flush cache?
Public propertyCautionWarning
Get caution warning number
Public propertyChanged
has record been changed since read?
Public propertyColorIndex
ColorIndex - used in Japan
Public propertyCompleted
Completed checkbox
Public propertyContact
The Contact for this appointment
Public propertyCreatedAssociate
The user that created the object
Public propertyCreatedDate
The date the object was saved to the database.
Public propertyDescription
Appointment text
Public propertyDoBy
deadline for todo, starttime for appointment
Public propertyDocument
Public propertyDocumentLink
OBSOLETE - use ActivityLinks instead.
Public propertyDone
date+time when task was completed.
Public propertyDuration
duration of appointment - in minutes
Public propertyEmailId
EmailId - If invitation and status changes should be mailed, this is the ID of the email address used.
Public propertyEndDate
EndDate = DoBy + duration
Public propertyExternalFieldChanged
have external fields been changed?
Public propertyForeignKey
ForeignKey
Public propertyFreeBusy
FreeBusy - What kind of time is this: 0 = Busy, 1 = Free.
Public propertyGroup
Primary User Group of owning associate. Set implicitly by AssociateId.
Public propertyGroupID
The owner's primary user group id
Public propertyIdentity
The primary key on the primary table. Is zero for new objects. Is set when an object is saved.
Public propertyInvitedPerson
The person who is invited by the appointment
Public propertyIsAvailable
is record available in db?
Public propertyIsFavourite
Add/Remove this appointment from my favourites
Public propertyIsRecurring
Is this a recurring appointment.
Public propertyIsRequiredFilled
Are all the required fields filled out? Can we save the record?
Public propertyIsValid
does the record exist?
Public propertyLeadTime
LeadTime
Public propertyLocalizedCautionWarning
Localized caution warning text
Public propertyLocation
Location - Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want.
Public propertyMother
Mother appointment. Used for linking invitations to the main appointment.
Public propertyPerson
The Person for this appointment
Public propertyPriority
Priority - list item - table enTablePriority=79
Public propertyPrivate
Visible for who? Public/Private 0=public,1=private,2=group
Public propertyPrivateToGroup
The group this appointment is visible for when Private = group.
Public propertyProject
Project for this appointment
Public propertyPublishType
Publish type for this appointment: 0 = enPublishTypeUndefined, 1 = enPublishTypeExternal.
Public propertyRecurrence
Get the recurrence object for this appointment. If this is not a recurring event the object gets default zero values.
Public propertyRecurrenceRuleId
RecurrenceRuleId - Id for the recurrence rule for recurring appointments, otherwise 0.
Public propertyRejectCounter
RejectCounter - How many invitees have rejected this appointment.
Public propertyRejectReason
RejectReason - Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here.
Public propertySale
Sale for this appointment
Public propertySentry
Sentry settings for this object. Lets you find out your read/write access to the object.
Public propertyStatus
Status for the appointment, for example: 1 = not started/accepted, 3 = completed, 5 = booking, 9 = declined.
Public propertySuggestedAppointmentId
Gets the suggested appointment id
Public propertyTask
Appointment task type - list item - table enTableTask=67
Public propertyTimeZoneLocationId
Gets the Timezone location id this appointment was stored under
Public propertyType
1=diary,2=checklist,6=invite
Public propertyUDef
UDef - The user-defined fields on the appointment.
Public propertyUpdatedAssociate
The last user to modify the object
Public propertyUpdatedDate
The date of the most recent update.
Public propertyUpdateMode
How will the recurring events be updated? For example: 0 = enNotSet, 1 = enOnlyThis, 2 = enThisAndForward...
Public propertyValidationMessage
get validation message, if empty model will think it is ok to save
Top
Methods
  NameDescription
Public methodAcceptInvitation
Accept or reject this invitation: 0 = Reject, 1 = Accept.
Public methodAddParticipant
Public methodAssignTo
Assign appointment to an associate, from another associate (default from current associate)
Public methodCancelChanges
Undo any changes made since the object was loaded.
Public methodChangeIdentity
Loads a different record into the object. Causes changes to the existing object to be saved first.
Public methodClone
Clone this appointment
Public methodDelete
Delete the object from the database. May throw an error if you are not allowed to delete the object.
Public methodGetNoOfParticipants
Number of participants for this booking.
Public methodGetParticipants
Get all participants of the required type for this appointment. Returns an SOAssociates or an SOPersons list depending on the type.
Public methodHasConflict
Has this appointment(booking) a time conflict? 0 = enResponseReject, 1 = enResponseAccept
Public methodInsertAppointmentPerson
If the main appointment has a person, insert the person as a participant on the booking.
Public methodIsSuggestedItem
Is this appointment used as a suggested appointment?
Public methodRemoveParticipant
Public methodSave
Persist the object to the database. May throw an error if you are not allowed to save changes to the object.
Public methodSetDefaults
Populate the object with default values, such as setting the owner to the current user.
Public methodSetDefaultsCall
SetDefaults for a phone call appointment. Has short duration. Starts now.
Public methodSetDefaultsToDo
SetDefaults for a ToDo appointment. Has no start time.
Public methodSuggestedItemId
Get the suggested item id
Top
See Also