Class UserNotification
Represents a notification sent to a user about events or updates within the platform.
public class UserNotification
- Inheritance
-
UserNotification
- Inherited Members
Remarks
Notifications are used to inform users about important events such as project invitations, join requests, and their outcomes. Each notification has a type that determines its purpose, and a JSON payload containing type-specific data. Notifications can be marked as read to track which ones the user has seen.
Properties
CreatedAtUtc
Gets or sets the UTC timestamp when this notification was created.
public DateTime CreatedAtUtc { get; set; }
Property Value
- DateTime
- Represents a notification sent to a user about events or updates within the platform.
Id
Gets or sets the unique identifier for this notification.
public Guid Id { get; set; }
Property Value
- Guid
- Represents a notification sent to a user about events or updates within the platform.
IsRead
Gets or sets a value indicating whether this notification has been read by the user.
public bool IsRead { get; set; }
Property Value
- bool
- Represents a notification sent to a user about events or updates within the platform.
Remarks
Unread notifications are typically highlighted in the UI and may trigger additional notifications (e.g., email, push notifications).
PayloadJson
Gets or sets the JSON payload containing type-specific notification data.
public string PayloadJson { get; set; }
Property Value
- string
- Represents a notification sent to a user about events or updates within the platform.
Remarks
The structure of this JSON depends on the Type. For example, a project invitation notification might include project details, sender information, and invitation metadata.
Type
Gets or sets the type of notification, which determines its purpose and the structure of the payload.
public NotificationType Type { get; set; }
Property Value
- NotificationType
- Represents a notification sent to a user about events or updates within the platform.
User
Gets or sets the user this notification belongs to.
public User User { get; set; }
Property Value
- User
- Represents a notification sent to a user about events or updates within the platform.
UserId
Gets or sets the unique identifier of the user this notification is for.
public Guid UserId { get; set; }
Property Value
- Guid
- Represents a notification sent to a user about events or updates within the platform.