Show / Hide Table of Contents

Class AppointmentInfoProvider

Implementation of IAppointmentInfo; create through factory (see remarks)

Inheritance
object
AppointmentInfoProvider
Implements
IAppointmentInfo
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: SuperOfficeCRMEntitiesProviders
Assembly: SoDataBase.BusinessLogic.dll
Syntax
public class AppointmentInfoProvider : IAppointmentInfo
Remarks

To create an instance of AppointmentInfoProvider, use

var info = ClassFactory.Create<IAppointmentInfo>(appnt);

where appnt is a Appointment, to use an already-loaded entity object (that may also contain unsaved data); or where cont is an int that is a contactId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

Constructors

AppointmentInfoProvider()

Declaration
public AppointmentInfoProvider()

Properties

AppointmentId

Primary key for the appointment

Declaration
public int AppointmentId { get; }
Property Value
Type Description
int

AssociateId

Owner associate id

Declaration
public int AssociateId { get; }
Property Value
Type Description
int

AssociateName

The appointment's owner, name

Declaration
public 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
public string AssociateOwnerName { get; }
Property Value
Type Description
string

ContactId

Associated contact id

Declaration
public int ContactId { get; }
Property Value
Type Description
int

ContactName

Associated contact name

Declaration
public string ContactName { get; }
Property Value
Type Description
string

CreationDate

The appointment's creation date, formatted YYYYMMdd

Declaration
public string CreationDate { get; }
Property Value
Type Description
string

CreationTime

The appointment's creation time formatted HHmmss

Declaration
public string CreationTime { get; }
Property Value
Type Description
string

Description

Appointment description

Declaration
public string Description { get; }
Property Value
Type Description
string

DescriptionLine

First line of appointment description

Declaration
public string DescriptionLine { get; }
Property Value
Type Description
string

EMail

The appointment's owner's emailaddress

Declaration
public string EMail { get; }
Property Value
Type Description
string

EndDate

The appointment's enddate, formatted YYYYMMdd

Declaration
public string EndDate { get; }
Property Value
Type Description
string

EndTime

The appointment's endtime, formatted HHmmss

Declaration
public string EndTime { get; }
Property Value
Type Description
string

FreeBusy

Free/Busy time

Declaration
public string FreeBusy { get; }
Property Value
Type Description
string

ICalId

Unique id made for iCal. SerialnoDappointmentIdDinvitedIdDupdated. Where D is a separator

Declaration
public string ICalId { get; }
Property Value
Type Description
string

ICalPriority

Priority on ical format

Declaration
public int ICalPriority { get; }
Property Value
Type Description
int

InvitationClickText

The connection from "Use this link to open the Invitation dialog in SuperOffice"" shown for registered contacts. Blank if the recipient not is a registered contact.

Declaration
public string InvitationClickText { get; }
Property Value
Type Description
string

InvitationUrl

The connection from "superoffice:invitations" to the invitation dialog box

Declaration
public string InvitationUrl { get; }
Property Value
Type Description
string

InviteeId

Appointments invitee person id

Declaration
public int InviteeId { get; }
Property Value
Type Description
int

InviteeName

Appointments invitee person name

Declaration
public string InviteeName { get; }
Property Value
Type Description
string

IsMilestone

Is the appointment a milestone appointment? English text "Yes" or "No".

Declaration
public string IsMilestone { get; }
Property Value
Type Description
string

JoinMeetingUrl

The URL

Declaration
public string JoinMeetingUrl { get; }
Property Value
Type Description
string

Location

Appointment location

Declaration
public 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
public string MainRepeatingPattern { get; }
Property Value
Type Description
string

OldStartDate

The appointment's old start date, formatted as YYYYMMdd.

Declaration
public string OldStartDate { get; }
Property Value
Type Description
string

OldStartTime

The appointment's old start time, formatted as HHmmss.

Declaration
public string OldStartTime { get; }
Property Value
Type Description
string

PersonId

Associated person id

Declaration
public int PersonId { get; }
Property Value
Type Description
int

PersonName

The appointment's person, name

Declaration
public string PersonName { get; }
Property Value
Type Description
string

PreferredTZLocation

The preferred timezone for the appointment

Declaration
public int PreferredTZLocation { get; }
Property Value
Type Description
int

Priority

The appointment's priority in clear text

Declaration
public string Priority { get; }
Property Value
Type Description
string

PriorityId

The appointment's priority by number, 1 = low, 2 = medium, 3 = high

Declaration
public int PriorityId { get; }
Property Value
Type Description
int

ProjectId

Associated project id

Declaration
public int ProjectId { get; }
Property Value
Type Description
int

ProjectName

Associated project name

Declaration
public string ProjectName { get; }
Property Value
Type Description
string

PublishEndDate

Appointment, end date for publication

Declaration
public string PublishEndDate { get; }
Property Value
Type Description
string

PublishStartDate

Appointment, start date for publication

Declaration
public string PublishStartDate { get; }
Property Value
Type Description
string

RepeatingAppointmentId

Appointment ID for any repeating appointments

Declaration
public int RepeatingAppointmentId { get; }
Property Value
Type Description
int

RepeatingEndDate

The end date for the appointment's repeating pattern, formatted as yyyyMMdd

Declaration
public string RepeatingEndDate { get; }
Property Value
Type Description
string

RepeatingPattern

The entire appointment's repeating pattern, formatted as "RRULE:" + bpat + bsub + bunt

Declaration
public string RepeatingPattern { get; }
Property Value
Type Description
string

RepeatingPatternEnd

Repeating pattern end date

Declaration
public string RepeatingPatternEnd { get; }
Property Value
Type Description
string

RepeatingPatternText

The text "This appointment is part of a repeating pattern:"

Declaration
public string RepeatingPatternText { get; }
Property Value
Type Description
string

RepeatingPatternText2

The text "See below in this message for a list of the repeating appointments."

Declaration
public string RepeatingPatternText2 { get; }
Property Value
Type Description
string

RepeatingPatternWeekStart

Repeating pattern week start

Declaration
public string RepeatingPatternWeekStart { get; }
Property Value
Type Description
string

RepeatingStartDate

The start date for the appointment's repeating pattern, formatted as YYYYMMdd

Declaration
public string RepeatingStartDate { get; }
Property Value
Type Description
string

RepeatingTooltip

The appointment's tooltip for repeating appointments

Declaration
public string RepeatingTooltip { get; }
Property Value
Type Description
string

StartDate

Date or deadline if this is a task or an appointment

Declaration
public string StartDate { get; }
Property Value
Type Description
string

StartDateLabel

Date or deadline label

Declaration
public 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
public string StartDateTimeAndDuration { get; }
Property Value
Type Description
string

StartTime

The appointment's starttime, formatted HHmmss

Declaration
public string StartTime { get; }
Property Value
Type Description
string

State

The state of the appointment: "TENTATIVE", "CONFIRMED" eller "CANCELLED"

Declaration
public 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
public string SubRepeatingPattern { get; }
Property Value
Type Description
string

SuggestedAppointmentId

The appointments SuggestedAppointment ID. Return 0 when appointment is not part of a sale/project guide.

Declaration
public int SuggestedAppointmentId { get; }
Property Value
Type Description
int

Type

Activitytype

Declaration
public string Type { get; }
Property Value
Type Description
string

UpdatedCount

Number of times the appointment has been updated. (Only counts from version SIX)

Declaration
public int UpdatedCount { get; }
Property Value
Type Description
int

UpdatedDate

The date of the last update, formatted YYYYMMdd

Declaration
public string UpdatedDate { get; }
Property Value
Type Description
string

UpdatedTime

The time of the last update, formatted HHmmss

Declaration
public string UpdatedTime { get; }
Property Value
Type Description
string

Methods

AddEmailParticipantToInviteText(string, string)

Declaration
public static string AddEmailParticipantToInviteText(string email, string inviteString)
Parameters
Type Name Description
string email
string inviteString
Returns
Type Description
string

AddPersonParticipantToInviteTextAsync(Person, string, CancellationToken)

Declaration
public static Task<string> AddPersonParticipantToInviteTextAsync(Person person, string inviteString, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Person person
string inviteString
CancellationToken cancellationToken
Returns
Type Description
Taskstring

GetEmailAddressDictionaryAsync(AppointmentCollection, CancellationToken)

Getting a dictionary of email ids and their correspoinding email address

Declaration
public static Task<Dictionary<int, string>> GetEmailAddressDictionaryAsync(AppointmentCollection collection, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AppointmentCollection collection

Collection of appointments for which we want to find the email addresses

CancellationToken cancellationToken
Returns
Type Description
TaskDictionaryintstring

GetEmailAddressDictionaryAsync(AppointmentRow[], CancellationToken)

Getting a dictionary of email ids and their correspoinding email address

Declaration
public static Task<Dictionary<int, string>> GetEmailAddressDictionaryAsync(AppointmentRow[] rows, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AppointmentRow rows
CancellationToken cancellationToken
Returns
Type Description
TaskDictionaryintstring

GetInvitationFormattedListAsync(CancellationToken)

Formatted list of inviteted ??, made for iCal

Declaration
public Task<string> GetInvitationFormattedListAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Taskstring

GetInvitedListAsync(CancellationToken)

Formatted list of invited persons, humanly readable

Declaration
public Task<string> GetInvitedListAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Taskstring

GetRecurringTooltip(RecurrencePattern, DateTime, DateTime)

Gets the recurring tooltip for a given recurrence rule.

Declaration
public static string GetRecurringTooltip(RecurrencePattern pattern, DateTime start, DateTime end)
Parameters
Type Name Description
RecurrencePattern pattern
DateTime start
DateTime end
Returns
Type Description
string

The recurring tooltip.

GetRepeatingPatternText()

Gets the repeating pattern text.

Declaration
public static string GetRepeatingPatternText()
Returns
Type Description
string

The repeating pattern text.

GetUserDefinedDecimal(int)

Return a user defined value of type decimal

Declaration
public string GetUserDefinedDecimal(int fieldNo)
Parameters
Type Name Description
int fieldNo

Index of field to retrieve value for

Returns
Type Description
string

String representation of the value of specified field

GetUserDefinedDecimal(string)

Get the decimal udef value based on the prog.id name of the udef field.

Declaration
public 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(int)

Return a user defined value of type int

Declaration
public string GetUserDefinedInt(int fieldNo)
Parameters
Type Name Description
int fieldNo

Index of field to retrieve value for

Returns
Type Description
string

String representation of the value of specified field

GetUserDefinedInt(string)

Get the int udef value based on the prog.id name of the udef field.

Declaration
public int GetUserDefinedInt(string progId)
Parameters
Type Name Description
string progId

Program name of udef field

Returns
Type Description
int

int value of field, or MINVALUE if field not found

GetUserDefinedString(int)

Return a user defined value of type string

Declaration
public string GetUserDefinedString(int fieldNo)
Parameters
Type Name Description
int fieldNo

Index of field to retrieve value for

Returns
Type Description
string

Value of specified field

GetUserDefinedString(string)

Get the string udef value based on the prog.id name of the udef field.

Declaration
public 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

Implements

IAppointmentInfo

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top