SuperOffice.COM.SuperOfficeDB Namespace |
Class | Description | |
---|---|---|
![]() | DatabaseClass |
Interface | Description | |
---|---|---|
![]() | Database | Database Class |
![]() | IActivity | IActivity Interface
Never implemented |
![]() | IActivityLinks | ActivityLink - collections of documents attached to this appointment/sale/document
Never implemented |
![]() | IActivityList | A collection of activities. Each activity can be a sale, document or appointment.
Never implemented
A collection of activities. Each activity can be a sale, document or appointment |
![]() | IActivityListItem | Represents a row in an activity archive. Can be a document, appointment or sale row.
Never implemented
A collection of activities. Each activity can be a sale, document or appointment
Represents a row in an activity archive. Can be a document, appointment or sale row. |
![]() | IAddress | Addresses can be street, postal or private. |
![]() | IAdmin | You must have administrative permission to use this object. Allows users and roles to be created and edited.
|
![]() | IAppointment | Appointment object - represents to-do's, follow-ups, phone-calls. |
![]() | IAppointments | Appointments collection. |
![]() | IAppointments2 | Appointment collection. |
![]() | IAssociate | Associates can be internal users, resources, external users, anonymous or system users. This is a read-only object. To create or edit users, you need to use the Admin object. |
![]() | IAssociates | Associates collection. Indexed by associate id. The Associate list can be manipulated using the Admin API. |
![]() | IChecklist | Collection of diary checklist items for a particular user. Each item corresponds to an incomplete appointment, document, sale.
|
![]() | IChecklistItem | A checklist item is a row in the diary checklist. It represents an incomplete appointment, document or sale.
Collection of diary checklist items for a particular user. Each item corresponds to an incomplete appointment, document, sale.
A checklist item is a row in the diary checklist. It represents an incomplete appointment, document or sale. |
![]() | IConsentPerson | Represents a ConsentPerson record. |
![]() | IConsentPersons | Collection of ConsentPersons |
![]() | IContact | Contacts represent companies in the user interface. |
![]() | IContacts | Collection of Contact objects. Use GetFirst/GetNext or for-each to loop through the collection.
Use GetFirst/GetNext or for-each to loop through the collection. |
![]() | IContacts2 | Contact collection.
Use GetFirst/GetNext or for-each to loop through the collection. |
![]() | ICounters | Counters keep track of the most recent activity on a company or project. Note that counters may be out-of-date with respect to the actual state of the database. May be NULL if you do not have the Sales Intelligence license |
![]() | ICredential | ICredential Interface - get/set passwords information on IUser |
![]() | ICredentials | Collection of Credentials, indexed from 0. |
![]() | ICriteria | Criteria - a collection of Criterion objects indexed by internal id. Add a new criterion using NewCriterion, then Add it to the collection. |
![]() | ICriterion | A criterion is a field, an operator and one or more values for comparison.
|
![]() | ICriterionValue | A value (a number, date, list item) used by a criterion when searching.
A criterion is a field, an operator and one or more values for comparison.
A value (a number, date, list item) used by a criterion when searching. |
![]() | ICriterionValues | Collection of CriterionValues. Indexed by internal id. A criterion value tells the search system what to look for.
A criterion is a field, an operator and one or more values for comparison.
A value (a number, date, list item) used by a criterion when searching. |
![]() | IDatabase | The Database object gives access to superoffice objects after you have logged in.
The Database object gives access to SuperOffice objects after you have logged in. |
![]() | IDates | Collection of DATEs, indexed from 0. |
![]() | IDiaryOwner | DiaryOwner represent associate used in application diary. |
![]() | IDictionary | The Data Dictionary provides information about the database version, the tables installed, and the fields available on a table. You must use the SODictionarySDK to add or remove tables. |
![]() | IDocument | Documents represent files (usually Word documents or e-mail messages). The file should be generated before it can be edited/viewed |
![]() | IDocuments | collection of document objects |
![]() | IEmail | Email address object |
![]() | IEmails | Collection of e-mail objects. Indexed by internal id.
(email_id) |
![]() | IFind | This object has lots of function for performing simple searches. If you need more complex queries then you should use the ADO connection instead of the Find object.
|
![]() | IForeignKey | IForeignKey Interface - get/set foreign keys |
![]() | IInterest | Interest object - represents the checkboxes in the user interface on contact or person. |
![]() | IInterests | Collection of Interest objects on a contact or person, indexed by internal id |
![]() | IListTextHeading | IListTextHeading Interface
List headings |
![]() | IListTextHeadings | Collection of list headings. Indexed by heading id. Each heading contains a collection of list items.
List headings |
![]() | IListTextItem | IListTextItem Interface
List items |
![]() | IListTextItems | Collection of list items. Indexed by item id. Each item has an id, text and tooltip.
List items |
![]() | IMapCollection | A read-only collection indexed by ids. Supports enumeration. Add/remove methods may be added by sub-classes. |
![]() | IModelBase | IModelBase defines common operations used by the main objects like Contact, Person, Project, Sale, Appointment, Document. |
![]() | INumbers | INumbers Interface - get/set number sequences |
![]() | IPerson | Person object. A person is linked to a contact. |
![]() | IPersons | Collection of Person objects |
![]() | IPersons2 | Person collection. |
![]() | IPhone | Phone object. Hangs off Contact and Person objects. Automatically saved when the Contact or Person object is saved. |
![]() | IPhones | Phone object collection, indexed by internal id
(phone_id) |
![]() | IPreference | Read or write preference values here. Note that preferences can be set at an individual user's level, at user-group level, an database level, or system-wide level.
Read or write preference values here. Note that preferences can be set at an individual user's level, at user-group level, an database level, or system-wide level. |
![]() | IProject | Projects can have persons as project members, with specific roles. Appointments/Sales/Documents can be linked to a project. |
![]() | IProjectMember | IProjectMember Interface |
![]() | IProjectMembers | ProjectMembers collection. Indexed by project member id. Add to the collection by saving new ProjectMember objects. |
![]() | IProjects | Collection of Project items |
![]() | IProjects2 | Project collection. |
![]() | IQuote | IQuote Interface |
![]() | IQuoteAlternative | IQuoteAlternative Interface |
![]() | IQuoteLine | IQuoteLine Interface |
![]() | IQuoteVersion | IQuoteVersion Interface |
![]() | IRecurrence | Recurrence object - contains details on how an appointment repeats. Remember to call ComputeDates if you change any information. |
![]() | IRelation | A Relation links two records in the system. Currently used for activity links and for company/person links. |
![]() | IRelations | Collection of Relation objects |
![]() | IRole | Represents a role - which defines access rights to information. Can be modified if user has UserAdmin rights. |
![]() | IRoles | Role object collection, indexed by role id. Add new roles using Admin.CreateRole.
: Admin.CreateRole. |
![]() | ISale | ISale Interface |
![]() | ISales | Sales collection. |
![]() | ISaleStakeholder | ISaleStakeholder Interface |
![]() | ISaleStakeholders | Salestakeholders collection. Indexed by salestakeholder_id. Add to the collection by saving new SaleStakeholder objects. |
![]() | ISelection | ISelection Interface |
![]() | ISelectionMember | ISelectionMember Interface |
![]() | ISelectionMembers | SelectionMembers collection. Add and remove members using methods on the Selection object. |
![]() | ISelections2 | Selection collection. |
![]() | ISentry | Sentry returns the read/write settings for the object as a whole and for individual fields. |
![]() | ISettings | Database Settings - does not require a login before use |
![]() | IShipmentTypeReservation | Represents a ShipmentTypeReservation record. |
![]() | IShipmentTypeReservations | Collection of ShipmentTypeReservations |
![]() | ISOPicture | ISOPicture Interface - person, project or status monitor picture |
![]() | IStatusMonitor | Status Monitors tell you whether a given company or project matches a set of criteria. Note that status monitors may be out-of-date with respect to the actual state of the database. May be NULL if you do not have the Sales Intelligence license. May be read-onl |
![]() | IStatusMonitors | Collection of Status Monitors indexed by monitor id. May be inaccessible if you do not have the Sales Intelligence license |
![]() | IStatusMonitorValue | The status monitor value tells you how up to date a status monitor is with respect to the Contact or Project it is attached to.. |
![]() | IStatusMonitorValues | Collection of Status Monitor values indexed by monitor definition id. May be inaccessible if you do not have the Sales Intelligence license |
![]() | IStringResources | String Resource manager. Converts string ids into translated strings. |
![]() | ISuggestedAppointment | Suggested appointment object |
![]() | ISuggestedAppointments | SuggestedAppointments collection. Indexed by suggestedAppointment_id. |
![]() | ISuggestedDocument | Suggested document object |
![]() | ISuggestedDocuments | SuggestedDocuments collection. Indexed by suggestedDocument_id. |
![]() | ITimeZoneItem | ITimeZoneItem interface |
![]() | ITimeZoneItems | Collection of ITimeZone items |
![]() | ITimeZones | ITimeZones Interface to the TimeZone manager |
![]() | ITravelInfo | TravelInfo - contains status of communications with a given traveller.
|
![]() | ITravelInterface | ITravelInterface Interface |
![]() | ITravellers | Collection of traveller info objects. Gives status on all travellers.
|
![]() | IUDefField | A User-defined field - contains layout and database storage information, as well as value of field.
|
![]() | IUDefFields | Collection of user-defined fields. You can retrieve fields by name or by field id.
A User-defined field - contains layout and database storage information, as well as value of field.
Collection of user-defined fields. You can retrieve fields by name or by field id. |
![]() | IUrl | Url - web addresses. Contacts, persons, projects can all have web addresses |
![]() | IUrlLinkItem | IUrlLinkItem interface |
![]() | IUrlLinkItems | Collection of IUrlLinkItem items |
![]() | IUrls | Collection of web addresses, indexed by internal id
(url_id) |
![]() | IUser | The administration view of associate. Unlike Associate objects, users can be modified and saved. |
![]() | IUtils | Utilities. These may have reduced functionality in a release target
|
![]() | SOActivity | IActivity Interface
Never implemented |
![]() | SOActivityLinks | ActivityLink - collections of documents attached to this appointment/sale/document
Never implemented |
![]() | SOActivityList | IActivityList Interface
Never implemented
A collection of activities. Each activity can be a sale, document or appointment |
![]() | SOActivityListItem | IActivityListItem Interface
Never implemented
A collection of activities. Each activity can be a sale, document or appointment
Represents a row in an activity archive. Can be a document, appointment or sale row. |
![]() | SOAddress | Addresses can be street, postal or private. |
![]() | SOAdmin | IAdmin Interface
You must have administrative permission to use this object. Allows users and roles to be created and edited. |
![]() | SOAppointment | Appointment object - represents to-do's, follow-ups, phone-calls. |
![]() | SOAppointments | Appointments collection. |
![]() | SOAppointments2 | Appointments collection. |
![]() | SOAssociate | Associates can be internal users, resources, external users, anonymous or system users. This is a read-only object. To create or edit users, you need to use the Admin object. |
![]() | SOAssociates | Associates collection. Indexed by associate id. The Associate list can be manipulated using the Admin API. |
![]() | SOChecklist | IChecklist Interface
Collection of diary checklist items for a particular user. Each item corresponds to an incomplete appointment, document, sale. |
![]() | SOChecklistItem | IChecklistItem Interface
Collection of diary checklist items for a particular user. Each item corresponds to an incomplete appointment, document, sale.
A checklist item is a row in the diary checklist. It represents an incomplete appointment, document or sale. |
![]() | SOContact | Contacts represent companies in the user interface. |
![]() | SOContacts | IContacts Interface
Use GetFirst/GetNext or for-each to loop through the collection. |
![]() | SOCounters | Counters keep track of the most recent activity on a company or project. Note that counters may be out-of-date with respect to the actual state of the database. May be NULL if you do not have the Sales Intelligence license |
![]() | SOCredential | ICredential Interface - a single password |
![]() | SOCredentials | ICredentials Interface - collection of passwords. |
![]() | SOCriteria | Criteria - a collection of Criterion objects indexed by internal id. Add a new criterion using NewCriterion, then Add it to the collection. |
![]() | SOCriterion | ICriterion Interface
A criterion is a field, an operator and one or more values for comparison. |
![]() | SOCriterionValue | ICriterionValue Interface
A criterion is a field, an operator and one or more values for comparison.
A value (a number, date, list item) used by a criterion when searching. |
![]() | SOCriterionValues | Collection of CriterionValues. Indexed by internal id. A criterion value tells the search system what to look for.
A criterion is a field, an operator and one or more values for comparison.
A value (a number, date, list item) used by a criterion when searching. |
![]() | SODates | Collection of DATEs, indexed from 0. |
![]() | SODictionary | The Data Dictionary provides information about the database version, the tables installed, and the fields available on a table. You must use the SODictionarySDK to add or remove tables. |
![]() | SODocument | Documents represent files (usually Word documents or e-mail messages). The file should be generated before it can be edited/viewed |
![]() | SODocuments | Collection of document objects |
![]() | SOEmail | Email address object |
![]() | SOEmails | Collection of e-mail objects. Indexed by internal id.
(email_id) |
![]() | SOFind | IFind Interface
This object has lots of function for performing simple searches. If you need more complex queries then you should use the ADO connection instead of the Find object. |
![]() | SOForeignKey | IForeignKey Interface - get/set foreign keys |
![]() | SOInterest | Interest object - represents the checkboxes in the user interface on contact or person. |
![]() | SOInterests | Collection of Interest objects on a contact or person, indexed by internal id |
![]() | SONumbers | INumbers Interface - get/set number sequences |
![]() | SOPerson | Person object. A person is linked to a contact. |
![]() | SOPersons | IPersons Interface |
![]() | SOPhone | Phone object. Hangs off Contact and Person objects. Automatically saved when the Contact or Person object is saved. |
![]() | SOPhones | Phone object collection, indexed by internal id
(phone_id) |
![]() | SOPreference | IPreference Interface
Read or write preference values here. Note that preferences can be set at an individual user's level, at user-group level, an database level, or system-wide level. |
![]() | SOProject | Projects can have persons as project members, with specific roles. Appointments/Sales/Documents can be linked to a project. |
![]() | SOProjectMember | IProjectMember Interface |
![]() | SOProjectMembers | ProjectMembers collection. Indexed by project member id. Add to the collection by saving new ProjectMember objects. |
![]() | SOProjects | IProjects Interface |
![]() | SOQuote | IQuote Interface |
![]() | SOQuoteAlternative | IQuoteAlternative Interface |
![]() | SOQuoteLine | IQuoteLine Interface |
![]() | SOQuoteVersion | IQuoteVersion Interface |
![]() | SORecurrence | Recurrence object - contains details on how an appointment repeats. Remember to call ComputeDates if you change any information. |
![]() | SORelation | A Relation links two records in the system. Currently used for activity links and for company/person links. |
![]() | SORelations | IRelations Interface |
![]() | SORole | Represents a role - which defines access rights to information. Can be modified if user has UserAdmin rights. |
![]() | SORoles | Role object collection, indexed by role id. Add new roles using Admin.CreateRole.
: Admin.CreateRole. |
![]() | SOSale | ISale Interface |
![]() | SOSales | Sales collection. |
![]() | SOSaleStakeholder | ISaleStakeholder Interface |
![]() | SOSaleStakeholders | Collection of SaleStakeholders, indexed by salestakeholder_id |
![]() | SOSelection | ISelection Interface |
![]() | SOSelectionMember | A member in a Selection. This can be a Contact or a Person |
![]() | SOSelectionMembers | SelectionMembers collection. Add and remove members using methods on the Selection object. |
![]() | SOSentry | Sentry returns the read/write settings for the object as a whole and for individual fields. |
![]() | SOSettings | Database Settings - does not require a login before use |
![]() | SOStatusMonitor | Status Monitors tell you whether a given company or project matches a set of criteria. Note that status monitors may be out-of-date with respect to the actual state of the database. May be NULL if you do not have the Sales Intelligence license. May be read-onl |
![]() | SOStatusMonitors | Collection of Status Monitors indexed by monitor id. May be empty if you do not have the Sales Intelligence license |
![]() | SOStatusMonitorValue | Status Monitors tell you whether a given company or project matches a set of criteria. Note that status monitors may be out-of-date with respect to the actual state of the database. May be NULL if you do not have the Sales Intelligence license. May be read-onl |
![]() | SOStatusMonitorValues | Collection of Status Monitors indexed by monitor id. May be empty if you do not have the Sales Intelligence license |
![]() | SOStringResources | String Resource manager. Converts id to translated string. |
![]() | SOSuggestedAppointment | ISuggestedAppointment Interface |
![]() | SOSuggestedAppointments | Collection of ISuggestedappointments, indexed by suggestedAppointment_id |
![]() | SOTimeZoneItem | TimeZone Item |
![]() | SOTimeZoneItems | A collection of TimeZone Items |
![]() | SOTimeZones | TimeZone manager |
![]() | SOTravelInfo | TravelInfo Interface
|
![]() | SOTravelInterface | ITravelInterface Interface |
![]() | SOTravellers | ITravellers Interface
Collection of traveller info objects. Gives status on all travellers. |
![]() | SOUDefField | IUDefField Interface
A User-defined field - contains layout and database storage information, as well as value of field. |
![]() | SOUDefFields | IUDefFields Interface
A User-defined field - contains layout and database storage information, as well as value of field.
Collection of user-defined fields. You can retrieve fields by name or by field id. |
![]() | SOUrl | Url - web addresses. Contacts, persons, projects can all have web addresses |
![]() | SOUrlLinkItem | UrlLink Item |
![]() | SOUrlLinkItems | A collection of UrlLink Items |
![]() | SOUrls | Collection of web addresses, indexed by internal id
(url_id) |
![]() | SOUser | IUser Interface - administration view of associate. Unlike Associate objects, users can be modified and saved. |
![]() | SOUtils | Utilities, mostly for debugging
|
Enumeration | Description | |
---|---|---|
![]() | EActivityListType | Bitflag. What sort of information is loaded in activity list
SOContact.GetActivityList |
![]() | EAssocType | Enumeration of the SuperOffice CRM Associate types |
![]() | EChecklistMode | Bitflag. What sort of information is loaded in diary check list / activity list
Database.GetCheckList |
![]() | EDBType | Type of underlying database in use. Database vendor and version |
![]() | EDBVariant | The database variant: central or travel database |
![]() | EDictFieldType | Database field types |
![]() | EEncryptionVariant | How should travel info be encrypted during transfer? |
![]() | EFullNameFormatStyle | First name first or last? |
![]() | EnActivityLinkType | Enum for the different activitylink types |
![]() | EnAppointType | Type of appointment/document (meeting/document/phone/fax/mail) |
![]() | EnAssocRoleType | Role types |
![]() | EnCautionWarning | Enum for Caution warning on appointment |
![]() | EnCriterionLinkType | Different criteria can be combined using AND or OR operators. Only AND is supported at the moment. |
![]() | EnCriterionOperator | All types of criterion search operators |
![]() | EnDirection | Direction of appointment/document (unknown/in/out) |
![]() | EnFindOperator | Find operators for counter values - simplified subset of the full set of operators |
![]() | EnFreeBusy | Determines whether an appointment causes conflicts in the diary or not |
![]() | EnMoveActivitiesAction | Enum for the different choices when moving activities |
![]() | EnParticipantType | Type of participant in a booking - determines how should the invitation be handled |
![]() | EnPublishType | Publish an appointment/project/document to the extra-net |
![]() | EnQuoteStatus | Enum for the state of a quote-alternative or line |
![]() | EnQuoteVersionState | Enum for current state of a Quote version |
![]() | EnRecurrencePattern | The main recurrence pattern - determines how frequently appointments recur |
![]() | EnRecurrenceSubPattern | Variations on the main recurrence pattern. Not all patterns have sub-variations. |
![]() | EnRecurrenceUpdateMode | Determines how changes to an appointment should be copied to the rest of a recurrence series |
![]() | EnRecurrenceWeekDays | Weekdays can be added together to indicate recurrence on two days of the week. |
![]() | EnRelationshipToOwner | Role defines datarights using these relationships between objects |
![]() | EnResponse | User's response to an invitation: accept or reject the appointment |
![]() | EnSaleStatus | Status of sale (open/sold/lost) |
![]() | EnUDefType | What thing is the user defined field attached to?
Actually, parents of user-def fields |
![]() | EnUrlEncoding | Enum for the possible URL encodings of a string |
![]() | EnValueOverride | Enum indicating if has a pre-calculated value been overriden in a QuoteAlternative or QuoteLine, and in that case what & how? |
![]() | EPrefLevel | at what level of specificity is the preference stored?
SOPreference.Get |
![]() | EPrivacyLevel | Visible for settings. Private to group means that the PrivateToGroup property can be used to select the group.
SODocument.Private |
![]() | ESelectionType | What kind of selection: static, dynamic or combined |
![]() | ESentryType | Enumeration of all valid sentry types |
![]() | EUDefFieldType | Type of edit field used when editing the value in the user-interface
SOUdefField.FieldType |
![]() | SOTableId | SuperOffice Database tables are identified by a number. |