Communities.Notifications Entity

Namespace: Communities

A single notification of a user. Entity: Cmm_Notifications (Introduced in version 20.1)

Default Visualization

Default Display Text Format:
{Id}: {UserId}
Default Search Members:
__
Category: Definitions
Show in UI: CannotBeShown

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
CreationTimeUtc datetime The exact server time (in UTC), when the notification was created. Required Default(NowUtc) Filter(ge;le) ORD ReadOnly
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsRead boolean Specifies whether the user has read the notification. If the system changes the notification after first reading, the flag is reset to unread again. Required Default(false) Filter(eq)
NotificationClass string (64) The class of the notification from a predefined list of system classes. Required Filter(multi eq)
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.
Subject string (256) nullable The short subject of the notification (in the Default Culture of the user). Filter(eq;like)

References

Name Type Description
DataObject ExtensibleDataObjects (nullable) The data object about which the notification is created. Null means that the notification is not about any specific data object. Filter(multi eq)
User Users The user, who is notified. Required Filter(multi eq)

Attribute Details

CreationTimeUtc

The exact server time (in UTC), when the notification was created. Required Default(NowUtc) Filter(ge;le) ORD ReadOnly

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTimeUtc
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

IsRead

Specifies whether the user has read the notification. If the system changes the notification after first reading, the flag is reset to unread again. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

NotificationClass

The class of the notification from a predefined list of system classes. Required Filter(multi eq)

Type: string (64)
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Maximum Length: 64
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

Subject

The short subject of the notification (in the Default Culture of the user). Filter(eq;like)

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

Reference Details

DataObject

The data object about which the notification is created. Null means that the notification is not about any specific data object. Filter(multi eq)

Type: ExtensibleDataObjects (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

User

The user, who is notified. Required Filter(multi eq)

Type: Users
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

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

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Communities_Notifications?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Communities_Notifications?$top=10