using System;
using xPushService.Constants;

namespace xPushService.Models {
    public class XPushMessage {
        /// <summary>
        /// Specify the Type of Push Notification ...
        /// </summary>
        /// <value></value>
        public string Type { get; set; }

        /// <summary>
        /// Specify the Topic of PushNotification ...
        /// NOTE: XPushTopic enum contains default Values and User can Extends it ...
        /// </summary>
        /// <value></value>
        public string Topic { get; set; }

        /// <summary>
        /// Specify the Action Name by passing String Values ...
        /// NOTE: XPushAction enum contains default Values for Actions ... 
        /// </summary>
        /// <value></value>
        public string Action { get; set; }

        /// <summary>
        /// if this is a User Push Action, we had to pass Actor ...
        /// </summary>
        /// <value></value>
        public string Actor { get; set; }

        /// <summary>
        /// in CRUD actions or some Custom Actions, we can pass propper data
        /// to clients ... 
        /// </summary>
        /// <value></value>
        public string Payload { get; set; }

        /// <summary>
        /// the message or additional Informations for passing to client ...
        /// </summary>
        /// <value></value>
        public string Message { get; set; }

        /// <summary>
        /// Push notification date and time ...
        /// </summary>
        /// <value></value>
        public DateTime TimeStamp { get; set; }
    }
}