General.Contacts.ContactMechanismPurposes Entity

Namespace: General.Contacts

Contains user-defined purposes for processing contact mechanisms. Used for personal data management. Entity: Cm_Contact_Mechanism_Purposes (Introduced in version 18.2)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

General.Contacts.ContactMechanismPurposes

Attributes

Name	Type	Description
Code	string (16)	The unique code of the ContactMechanismPurpose. `Required` `Filter(eq;like)` `ORD`
ContactMechanismType	ContactMechanismType nullable	When specified, allows the purpose to be specified only for contact mechanisms of the specified type. `Filter(multi eq)`
Description	string (max) nullable	The description of this ContactMechanismPurpose. `Filter(like)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Name	MultilanguageString (254)	Name of the contact mechanism purpose (Multilanguage). `Required` `Filter(like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Attribute Details

Code

The unique code of the ContactMechanismPurpose. Required Filter(eq;like) ORD

Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault

ContactMechanismType

When specified, allows the purpose to be specified only for contact mechanisms of the specified type. Filter(multi eq)

Type: ContactMechanismType nullable
Category: System
Allowed values for the ContactMechanismType(General.Contacts.ContactMechanisms.md#contactmechanismtype) data attribute
Allowed Values (General.Contacts.ContactMechanismsRepository.ContactMechanismType Enum Members)

Value	Description
Address	Address value. Stored as 'A'. Database Value: 'A' Model Value: 0 Domain API Value: 'Address'
Mail	Mail value. Stored as 'E'. Database Value: 'E' Model Value: 1 Domain API Value: 'Mail'
Fax	Fax value. Stored as 'F'. Database Value: 'F' Model Value: 2 Domain API Value: 'Fax'
MobilePhone	MobilePhone value. Stored as 'M'. Database Value: 'M' Model Value: 3 Domain API Value: 'MobilePhone'
Other	Other value. Stored as 'O'. Database Value: 'O' Model Value: 4 Domain API Value: 'Other'
Telephone	Telephone value. Stored as 'T'. Database Value: 'T' Model Value: 5 Domain API Value: 'Telephone'
WebSite	WebSite value. Stored as 'W'. Database Value: 'W' Model Value: 6 Domain API Value: 'WebSite'
PostalCode	PostalCode value. Stored as 'P'. Database Value: 'P' Model Value: 7 Domain API Value: 'PostalCode'
WebProfile	WebProfile value. Stored as 'X'. Database Value: 'X' Model Value: 8 Domain API Value: 'WebProfile'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Description

The description of this ContactMechanismPurpose. Filter(like)

Type: string (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

Name

Name of the contact mechanism purpose (Multilanguage). Required Filter(like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST