Interface IAppointmentInfo
Interface providing information about the appointment.
Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public interface IAppointmentInfo
Properties
AppointmentId
Primary key for the appointment
Declaration
int AppointmentId { get; }
Property Value
Type | Description |
---|---|
Int32 |
AssociateId
Owner associate id
Declaration
int AssociateId { get; }
Property Value
Type | Description |
---|---|
Int32 |
AssociateName
The appointment's owner, name
Declaration
string AssociateName { get; }
Property Value
Type | Description |
---|---|
String |
AssociateOwnerName
Name of owner associate If this is a child booking, we want to look to the mother appointment's owner
Declaration
string AssociateOwnerName { get; }
Property Value
Type | Description |
---|---|
String |
ContactId
Associated contact id
Declaration
int ContactId { get; }
Property Value
Type | Description |
---|---|
Int32 |
ContactName
Associated contact name
Declaration
string ContactName { get; }
Property Value
Type | Description |
---|---|
String |
CreationDate
The appointment's creation date, formatted YYYYMMdd
Declaration
string CreationDate { get; }
Property Value
Type | Description |
---|---|
String |
CreationTime
The appointment's creation time formatted HHmmss
Declaration
string CreationTime { get; }
Property Value
Type | Description |
---|---|
String |
Description
Appointment description
Declaration
string Description { get; }
Property Value
Type | Description |
---|---|
String |
DescriptionLine
First line of appointment description
Declaration
string DescriptionLine { get; }
Property Value
Type | Description |
---|---|
String |
The appointment's owner's emailaddress
Declaration
string EMail { get; }
Property Value
Type | Description |
---|---|
String |
EndDate
The appointment's enddate, formatted YYYYMMdd
Declaration
string EndDate { get; }
Property Value
Type | Description |
---|---|
String |
EndTime
The appointment's endtime, formatted HHmmss
Declaration
string EndTime { get; }
Property Value
Type | Description |
---|---|
String |
FreeBusy
Free/Busy time
Declaration
string FreeBusy { get; }
Property Value
Type | Description |
---|---|
String |
ICalId
Unique id made for iCal. SerialnoDappointmentIdDinvitedIdDupdated. Where D is a separator
Declaration
string ICalId { get; }
Property Value
Type | Description |
---|---|
String |
ICalPriority
Priority on ical format
Declaration
int ICalPriority { get; }
Property Value
Type | Description |
---|---|
Int32 |
InvitationClickText
The connection from "Click here to open the SuperOffice SIX dialog box" shown for registered contacts. Blank if the recipient not is a registered contact
Declaration
string InvitationClickText { get; }
Property Value
Type | Description |
---|---|
String |
InvitationFormattedList
Formatted list of inviteted ??, made for iCal
Declaration
string InvitationFormattedList { get; }
Property Value
Type | Description |
---|---|
String |
InvitationUrl
The connection from "superoffice:invitations" to the invitation dialog box
Declaration
string InvitationUrl { get; }
Property Value
Type | Description |
---|---|
String |
InviteeId
User ID for this rows invitee (Used with bookings)
Declaration
int InviteeId { get; }
Property Value
Type | Description |
---|---|
Int32 |
InviteeName
The name of this rows invited person
Declaration
string InviteeName { get; }
Property Value
Type | Description |
---|---|
String |
Location
Appointment location
Declaration
string Location { get; }
Property Value
Type | Description |
---|---|
String |
MainRepeatingPattern
The main feature of the appointments repeating pattern, formatted like the Daily pattern "FREQ=DAILY;" for example
Declaration
string MainRepeatingPattern { get; }
Property Value
Type | Description |
---|---|
String |
PersonId
Associated person id
Declaration
int PersonId { get; }
Property Value
Type | Description |
---|---|
Int32 |
PersonName
The appointment's person, name
Declaration
string PersonName { get; }
Property Value
Type | Description |
---|---|
String |
PreferredTZLocation
The preferred timezone for the appointment
Declaration
int PreferredTZLocation { get; }
Property Value
Type | Description |
---|---|
Int32 |
Priority
The appointment's priority in clear text
Declaration
string Priority { get; }
Property Value
Type | Description |
---|---|
String |
PriorityId
The appointment's priority by number, 1 = low, 2 = medium, 3 = high
Declaration
int PriorityId { get; }
Property Value
Type | Description |
---|---|
Int32 |
ProjectId
Associated project id
Declaration
int ProjectId { get; }
Property Value
Type | Description |
---|---|
Int32 |
ProjectName
Associated project name
Declaration
string ProjectName { get; }
Property Value
Type | Description |
---|---|
String |
PublishEndDate
Appointment, end date for publication
Declaration
string PublishEndDate { get; }
Property Value
Type | Description |
---|---|
String |
PublishStartDate
Appointment, start date for publication
Declaration
string PublishStartDate { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingAppointmentId
Appointment ID for any repeating appointments
Declaration
int RepeatingAppointmentId { get; }
Property Value
Type | Description |
---|---|
Int32 |
RepeatingEndDate
The end date for the appointment's repeating pattern, formatted as yyyyMMdd
Declaration
string RepeatingEndDate { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingPattern
The entire appointment's repeating pattern, formatted as "RRULE:" + bpat + bsub + bunt
Declaration
string RepeatingPattern { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingPatternEnd
Repeating pattern end date
Declaration
string RepeatingPatternEnd { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingPatternText
The text "This appointment is part of a repeating pattern:"
Declaration
string RepeatingPatternText { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingPatternText2
The text "See below in this message for a list of the repeating appointments."
Declaration
string RepeatingPatternText2 { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingPatternWeekStart
Repeating pattern week start
Declaration
string RepeatingPatternWeekStart { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingStartDate
The start date for the appointment's repeating pattern, formatted as YYYYMMdd
Declaration
string RepeatingStartDate { get; }
Property Value
Type | Description |
---|---|
String |
RepeatingTooltip
The appointment's tooltip for repeating appointments
Declaration
string RepeatingTooltip { get; }
Property Value
Type | Description |
---|---|
String |
StartDate
Date or deadline if this is a task or an appointment
Declaration
string StartDate { get; }
Property Value
Type | Description |
---|---|
String |
StartDateLabel
Date or deadline label
Declaration
string StartDateLabel { get; }
Property Value
Type | Description |
---|---|
String |
StartDateTimeAndDuration
The appointment's date and time. E.g. 30.03.2005 (16:00)-(17:00).
Declaration
string StartDateTimeAndDuration { get; }
Property Value
Type | Description |
---|---|
String |
StartTime
The appointment's starttime, formatted HHmmss
Declaration
string StartTime { get; }
Property Value
Type | Description |
---|---|
String |
State
The state of the appointment: "TENTATIVE", "CONFIRMED" eller "CANCELLED"
Declaration
string State { get; }
Property Value
Type | Description |
---|---|
String |
SubRepeatingPattern
The secondary feature of the appointment's repeating pattern, formatted as the sub-pattern Daily Workday "BYDAY=MO,TU,WE,TH,FR;", for example
Declaration
string SubRepeatingPattern { get; }
Property Value
Type | Description |
---|---|
String |
Type
Activitytype
Declaration
string Type { get; }
Property Value
Type | Description |
---|---|
String |
UpdatedCount
Number of times the appointment has been updated. (Only counts from version SIX)
Declaration
int UpdatedCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
UpdatedDate
The date of the last update, formatted YYYYMMdd
Declaration
string UpdatedDate { get; }
Property Value
Type | Description |
---|---|
String |
UpdatedTime
The time of the last update, formatted HHmmss
Declaration
string UpdatedTime { get; }
Property Value
Type | Description |
---|---|
String |
Methods
GetUserDefinedDecimal(Int32)
User-defined field 1-10 of the decimal (.NET double) number type.
Declaration
string GetUserDefinedDecimal(int fieldNo)
Parameters
Type | Name | Description |
---|---|---|
Int32 | fieldNo | Field number (1-10). |
Returns
Type | Description |
---|---|
String | User-defined field value. |
GetUserDefinedDecimal(String)
Get the decimal udef value based on the prog.id name of the udef field.
Declaration
double GetUserDefinedDecimal(string progId)
Parameters
Type | Name | Description |
---|---|---|
String | progId | Program name of udef field |
Returns
Type | Description |
---|---|
Double | double value of field, or NAN if field not found |
GetUserDefinedInt(Int32)
Get user-defined field 1-60 of the whole (.NET Int32) number type.
Declaration
string GetUserDefinedInt(int fieldNo)
Parameters
Type | Name | Description |
---|---|---|
Int32 | fieldNo | Field number (1-60). |
Returns
Type | Description |
---|---|
String | User-defined field value. |
GetUserDefinedInt(String)
Get the int udef value based on the prog.id name of the udef field.
Declaration
int GetUserDefinedInt(string progId)
Parameters
Type | Name | Description |
---|---|---|
String | progId | Program name of udef field |
Returns
Type | Description |
---|---|
Int32 | int value of field, or MINVALUE if field not found |
GetUserDefinedString(Int32)
Get user-defined field 1-49 of the text (.NET string) type.
Declaration
string GetUserDefinedString(int fieldNo)
Parameters
Type | Name | Description |
---|---|---|
Int32 | fieldNo | Field number (1-39). |
Returns
Type | Description |
---|---|
String | User-defined field value. |
GetUserDefinedString(String)
Get the string udef value based on the prog.id name of the udef field.
Declaration
string GetUserDefinedString(string progId)
Parameters
Type | Name | Description |
---|---|---|
String | progId | Program name of udef field |
Returns
Type | Description |
---|---|
String | string value of field, or NULL if field not found |