Class SelectionEntity
Namespace: SuperOffice.WebApi.DataAssembly: SuperOffice.WebApi.dll Carrier object for SelectionEntity.
Inheritance
object ← Carrier ← SelectionEntityInherited Members
Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()Examples
Get SelectionEntity 123 using the WebApi client:var configuration = new WebApiConfiguration(url);
var agent = new SelectionAgent(configuration);
var selectionEntity = agent.GetSelectionEntity( 123 );
Remarks
Use“FindSelection”
Constructors
SelectionEntity()
Default constructor - defaults any enum props to 0.Properties
Associate
Owner of the selectionProperty Value
AssociateChartKey
ID/key of the last-used chart tile on this selectionProperty Value
stringCompanyUnique
Filter out duplicate members based on company?Property Value
boolCompleted
The Completed state.Property Value
boolCreatedBy
Who created the selectionProperty Value
AssociateCreatedDate
Registered whenProperty Value
DateTimeDashboardTileDefinitionId
The associated tile definitionProperty Value
intDescription
The actual text, max 2047 significant characters even though it is stored as a larger data type on some databasesProperty Value
stringGroupIdx
Original primary user group of associateProperty Value
intIncludePerson
0 = Include first person, 1 = Include all persons, 2 = Include no personsProperty Value
intLastLoaded
The date/time this selection was last loaded (selectionentity fetched)Property Value
DateTimeLastLoadedBy
Who last loaded this selectionProperty Value
intLastLoadedByAssociate
Associate that last looked at the selection members; only date (not time) is validProperty Value
AssociateLastMembershipChange
The date/time the membership the selection last changed. Dynamic: change of criteria; Static: add/remove members; Combined: change of algorithmProperty Value
DateTimeLastMembershipChangeBy
Who last changed the membershipProperty Value
intLastMembershipChangeByAssociate
Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is validProperty Value
AssociateLeftSelectionId
LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.Property Value
intMailingsProviderName
The name of the provider for the Mailings tab, if relevant; this string will contain resource referencesProperty Value
stringMainHeading
‘Static selection of Companies’, or whatever else is appropriate, made by combining text resources for the type and the entity (plural form); this string will contain resource referencesProperty Value
stringMainProviderName
The name of the Archive Provider that will deliver the content of the archive - the actual entity rowsProperty Value
stringMemberCount
How many selectionmembers (for progress bar calculations) - estimate, -1 (or 4294967295) means we don’t knowProperty Value
uintMemberTabHeading
‘Companies’, or whatever else is appropriate - the plural form of the entity name; this string will contain resource referencesProperty Value
stringName
Name of selection, freetext indexedProperty Value
stringPostit
The actual text, max 2047 significant characters even though it is stored as a larger data type on some databasesProperty Value
stringPostitTextId
Postit text record id.Property Value
intRightSelectionId
RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.Property Value
intSelectionCategory
Selection category type (list item)Use MDO List name “searchCat” to get list items.