Class AppointmentEntity

Partial AppointmentEntity class associating the generated AppointmentEntity with an interface.

Inheritance
object
AppointmentEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class AppointmentEntity : Carrier, IActivityEntityCarrier, IRelationEntityCarrier, ILinksContainerEntityCarrier, IProjectRelationEntityCarrier, IContactPersonRelationEntityCarrier, IEntityCarrier, IUdefFieldCarrier, IExtraFieldCarrier, IPublishedCarrier, IVisibleForCarrier
Examples

Get AppointmentEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new AppointmentAgent();
   var appointmentEntity = agent.GetAppointmentEntity( 123 );
}

Find all AppointmentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindAppointment", "...", null, "getAllRows eq 1", null, 0, 100 );
var participants = archive.GetArchiveListByColumns2("Participants", "...", null, "appointmentRestrictionId eq 123", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceAppointmentRestrictionId eq 123", null, 0, 100 );

Constructors

AppointmentEntity()

Default constructor

Declaration
public AppointmentEntity()
See Also

Properties

ActiveDate

The date to be used for searching & showing

Declaration
[DataMember]
public virtual DateTime ActiveDate { get; set; }
Property Value
Type Description
DateTime
See Also

Number of active links to sale, document, appointment.

Declaration
[DataMember]
public virtual int ActiveLinks { get; set; }
Property Value
Type Description
int

Agenda

The agenda of the appointment.

Declaration
[DataMember]
public virtual string Agenda { get; set; }
Property Value
Type Description
string
See Also

AlarmLeadTime

Alarm lead time.

Declaration
[DataMember]
public virtual TimeSpan AlarmLeadTime { get; set; }
Property Value
Type Description
TimeSpan
See Also

AppointmentId

Primary key

Declaration
[DataMember]
public virtual int AppointmentId { get; set; }
Property Value
Type Description
int
See Also

AssignedBy

Who assigned this appointment to this user? Whose diary did the appointment come from?

Declaration
[DataMember]
public virtual Associate AssignedBy { get; set; }
Property Value
Type Description
Associate
See Also

AssignmentStatus

Status if this appointment is in the process of being assigned to someone else

Declaration
[DataMember]
public virtual AssignmentStatus AssignmentStatus { get; set; }
Property Value
Type Description
AssignmentStatus
See Also

Associate

The owner of the appointment - the associate whose diary/checklist the appointment is in.

Use MDO List name "associate" to get list items.

Declaration
[DataMember]
public virtual Associate Associate { get; set; }
Property Value
Type Description
Associate
See Also

BookingType

The type of booking the appointment represents

Declaration
[DataMember]
public virtual BookingType BookingType { get; set; }
Property Value
Type Description
BookingType
See Also

CautionWarning

Status field to indicate appointments that have some sort of problem

Declaration
[DataMember]
public virtual AppointmentCautionWarning CautionWarning { get; set; }
Property Value
Type Description
AppointmentCautionWarning
See Also

CentralserviceVideomeetId

GUID for video meeting in central services – this is set when we create meetings from SuperOffice. It is blank for incoming meetings created from inbox.

Declaration
[DataMember]
public virtual string CentralserviceVideomeetId { get; set; }
Property Value
Type Description
string
See Also

ColorIndex

Appointment colour, used only in Japanese versions. Western versions take colour from Task

Declaration
[DataMember]
public virtual short ColorIndex { get; set; }
Property Value
Type Description
short
See Also

Completed

Appointment Completed state. This property is the part of the Status property that is the completed state. Could be three state if the three state user preference is set.

Declaration
[DataMember]
public virtual ActivityStatus Completed { get; set; }
Property Value
Type Description
ActivityStatus
See Also

Contact

The contact associated with the appointment. It may also be null if no contact is associated with the appointment.

Use MDO List name "contact_new" to get list items.

Declaration
[DataMember]
public virtual Contact Contact { get; set; }
Property Value
Type Description
Contact
See Also

CreatedBy

The associate that first created the appointment. The property is read-only.

Declaration
[DataMember]
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
See Also

CreatedDate

Registered date in UTC.

Declaration
[DataMember]
public virtual DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual ExtraFields and UserDefinedFields properties are deprecated in favor of this combined collection.

Declaration
[DataMember]
public StringDictionary CustomFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Extra field data [Extra field name]

Example: 
'x_gorp' = '[I:123]'
User defined field data [Prog-id name]

Example: 
'SuperOffice:1' = '[I:123]'

See Also

Description

Description of the appointment.

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

EndDate

Date + end time planned

Declaration
[DataMember]
public virtual DateTime EndDate { get; set; }
Property Value
Type Description
DateTime
See Also

ExtraFields

Deprecated: Use CustomFields instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Declaration
[DataMember]
public StringDictionary ExtraFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Plug-in data [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType
Foreign key data The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry
User defined table data [Table name].[Field name] Example: Phunneling.AggregatedSales
Other Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
See Also

HasAlarm

Does this appointment have an alarm

Declaration
[DataMember]
public virtual bool HasAlarm { get; set; }
Property Value
Type Description
bool
See Also

HasConflict

Does the appointment overlap with another appointment in the user's diary?

Declaration
[DataMember]
public virtual bool HasConflict { get; set; }
Property Value
Type Description
bool
See Also

InternalNotes

Internal notes for the appointment.

Declaration
[DataMember]
public virtual string InternalNotes { get; set; }
Property Value
Type Description
string
See Also

InvitationStatus

Status if this appointment represents an invitation

Declaration
[DataMember]
public virtual InvitationStatus InvitationStatus { get; set; }
Property Value
Type Description
InvitationStatus
See Also

InvitedPerson

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.

Declaration
[DataMember]
public virtual Person InvitedPerson { get; set; }
Property Value
Type Description
Person
See Also

IsAlldayEvent

True if all day event

Declaration
[DataMember]
public virtual bool IsAlldayEvent { get; set; }
Property Value
Type Description
bool
See Also

IsFree

True if free, false if busy

Declaration
[DataMember]
public virtual bool IsFree { get; set; }
Property Value
Type Description
bool
See Also

IsMileStone

Is this appointment a milestone?

Declaration
[DataMember]
public virtual bool IsMileStone { get; set; }
Property Value
Type Description
bool
See Also

IsPublished

Publication is published

Declaration
[DataMember]
public bool IsPublished { get; set; }
Property Value
Type Description
bool
See Also

JoinVideomeetUrl

Blank when not a video meeting. Filled with Join Meeting URL when created.

Declaration
[DataMember]
public virtual string JoinVideomeetUrl { get; set; }
Property Value
Type Description
string
See Also

LagTime

as leadtime, but after the end - time blocked for travel etc.

Declaration
[DataMember]
public virtual TimeSpan LagTime { get; set; }
Property Value
Type Description
TimeSpan
See Also

LeadTime

Time blocked (minutes) BEFORE starttime

Declaration
[DataMember]
public virtual TimeSpan LeadTime { get; set; }
Property Value
Type Description
TimeSpan
See Also

List of all elements linked to the appointment.

Declaration
[DataMember]
public virtual Link[] Links { get; set; }
Property Value
Type Description
Link[]

Location

Location for appointment, defaulted from invited resource of type place and other rules, but you can write anything you want here

Declaration
[DataMember]
public virtual string Location { get; set; }
Property Value
Type Description
string
See Also

MotherAssociate

The owner of the mother appointment - the associate whose diary/checklist the mother appointment is in. The mother appointment is the one identified by the mother_id. If the mother_id is 0 or the same as this appointment_id, then the master associate will be the same as the 'ordinary' associate.

Declaration
[DataMember]
public virtual Associate MotherAssociate { get; set; }
Property Value
Type Description
Associate
See Also

MotherId

ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment. However, if 0 and assoc_id != reg_id then this is an assigned appointment, indicated vt type = kBooking

Declaration
[DataMember]
public virtual int MotherId { get; set; }
Property Value
Type Description
int
See Also

OwnedExternally

Set if an external system owns this appointment.

Declaration
[DataMember]
public virtual AppointmentExternalOwner OwnedExternally { get; set; }
Property Value
Type Description
AppointmentExternalOwner
See Also

Participants

List of id's of the participants to this appointment.

Declaration
[DataMember]
public virtual ParticipantInfo[] Participants { get; set; }
Property Value
Type Description
ParticipantInfo[]
See Also

Person

An appointment may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required.

Use MDO List name "person" to get list items.

Declaration
[DataMember]
public virtual Person Person { get; set; }
Property Value
Type Description
Person
See Also

PreferredTZLocation

Appointments preferred timezone location.

Declaration
[DataMember]
public virtual int PreferredTZLocation { get; set; }
Property Value
Type Description
int
See Also

PreferredTZLocationData

Read-only timezone data for PreferredTZLocation.

Declaration
[DataMember]
public virtual TimeZoneData PreferredTZLocationData { get; set; }
Property Value
Type Description
TimeZoneData
See Also

Priority

It's 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.

Use MDO List name "priority" to get list items.

Declaration
[DataMember]
public virtual Priority Priority { get; set; }
Property Value
Type Description
Priority
See Also

Private

The confidentiality of appointments is shown as different types of “private” on the appointment. For an updated list of “private” types, see the database manual.

Declaration
[DataMember]
public virtual AppointmentPrivate Private { get; set; }
Property Value
Type Description
AppointmentPrivate
See Also

Project

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.

Use MDO List name "project" to get list items.

Declaration
[DataMember]
public virtual Project Project { get; set; }
Property Value
Type Description
Project
See Also

PublishEventDate

Publish event date

Declaration
[DataMember]
public DateTime PublishEventDate { get; set; }
Property Value
Type Description
DateTime
See Also

PublishFrom

Publication valid from (inclusive)

Declaration
[DataMember]
public DateTime PublishFrom { get; set; }
Property Value
Type Description
DateTime
See Also

PublishTo

Publication valid to (inclusive)

Declaration
[DataMember]
public DateTime PublishTo { get; set; }
Property Value
Type Description
DateTime
See Also

Recurrence

The appointment recurrence.

Declaration
[DataMember]
public virtual RecurrenceInfo Recurrence { get; set; }
Property Value
Type Description
RecurrenceInfo
See Also

RejectCounter

How many invitees have rejected this appointment

Declaration
[DataMember]
public virtual short RejectCounter { get; set; }
Property Value
Type Description
short
See Also

RejectReason

Why was this booking or assignment rejected, the RejectReason list is a source of suggestions but you can write anything here

Use MDO List name "rejectReason" to get list items.

Declaration
[DataMember]
public virtual string RejectReason { get; set; }
Property Value
Type Description
string
See Also

Sale

An appointment may also be connected to a sale, so you see the appointment on the company card, on the project card and on the sale card. This does not mean however that a sale is required.

Use MDO List name "sale" to get list items.

Declaration
[DataMember]
public virtual Sale Sale { get; set; }
Property Value
Type Description
Sale
See Also

StartDate

date + start time planned

Declaration
[DataMember]
public virtual DateTime StartDate { get; set; }
Property Value
Type Description
DateTime
See Also

SuggestedAppointmentId

Suggested guide item that this appointment is an instance of (Note: NOT VALID for document-type appointments, they have their own link)

Declaration
[DataMember]
public virtual int SuggestedAppointmentId { get; set; }
Property Value
Type Description
int
See Also

Task

Task comprises the different types of activities, like “Phone call”, “Meeting” and so on.

Use MDO List name "task" to get list items.

Declaration
[DataMember]
public virtual TaskListItem Task { get; set; }
Property Value
Type Description
TaskListItem
See Also

Title

The title of the appointment.

Declaration
[DataMember]
public virtual string Title { get; set; }
Property Value
Type Description
string
See Also

Type

The different types of appointment, if the appointment is supposed to be shown in the diary or checklist, or if it's a document. See the different types of appointments in the database manual.

Declaration
[DataMember]
public virtual AppointmentType Type { get; set; }
Property Value
Type Description
AppointmentType
See Also

UpdatedBy

The person that last updated the appointment.

Declaration
[DataMember]
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
See Also

UpdatedDate

Updated date in UTC.

Declaration
[DataMember]
public virtual DateTime UpdatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

UserDefinedFields

Deprecated: Use CustomFields instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

Declaration
[DataMember]
public StringDictionary UserDefinedFields { get; set; }
Property Value
Type Description
StringDictionary
See Also

VisibleFor

The set of users or groups the record is visible for

Declaration
[DataMember]
public VisibleFor[] VisibleFor { get; set; }
Property Value
Type Description
VisibleFor[]
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

Implements

See Also