/// <summary>
/// The PushClient API provides functions to connect to push service for receiving push messages.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
/// The PushClient API provides the way to connect with the push service.
/// It provides api's to connect/disconnect from the push service.
/// <summary>
/// Event Handler for receiving the notifications.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static event EventHandler<PushMessageEventArgs> NotificationReceived
{
add
/// <summary>
/// Event Handler for receiving changes in States of the connection.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static event EventHandler<PushConnectionStateEventArgs> StateChanged
{
add
/// <summary>
/// API to connect with the push service.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="pushAppId"> The Push Application Id Registered with the server.</param>
public static void PushServiceConnect(string pushAppId)
{
/// <summary>
/// API to disconnect from the push service.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static void PushServiceDisconnect()
{
PushImpl.Instance.PushServiceDisconnect();
/// <summary>
/// API to Register the application with the push server.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// The method returns a task which on completion with give a ServerResponse Object.
/// </returns>
/// <summary>
/// API to Deregister the application from the push server.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// The method returns a task which on completion with give a ServerResponse Object.
/// </returns>
/// <summary>
/// Gets the unread notifications for the application.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static void GetUnreadNotifications()
{
PushImpl.Instance.GetUnreadNotifications();
/// <summary>
/// registration Id received from server. </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>
/// It is the string which is the Id received from the server.
/// </returns>
/// <summary>
/// An extended EventArgs class which contains the State Information.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PushConnectionStateEventArgs : EventArgs
{
/// <summary>
/// Enumeration for the different states.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum PushState
{
/// <summary>
/// <summary>
/// Gives the current state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is the current state.</value>
public PushState State
/// <summary>
/// Gives information about the error if set.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is the string which contains the error string if set.</value>
public string Error
/// <summary>
/// An extended EventArgs class which contains the message received.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public class PushMessageEventArgs : EventArgs
{
/// <summary>
/// Gives the Application Data recieved. </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is the string which stores the application data.</value>
public string AppData
/// <summary>
/// Gives the Message Received Field.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is the string which stores the message field.</value>
public string Message
/// <summary>
/// Gives the time at which the Notification was received.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is the DateTime field representing the time at which the Notification was received.</value>
public DateTime ReceivedAt
/// <summary>
/// Gives the Sender of the notification.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is a string value representing the Sender of the Notification.</value>
public string Sender
/// <summary>
/// Gives the session ID of the notification.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is a string value representing the session ID of the Notification.</value>
public string SessionInfo
/// <summary>
/// Gives the request Id of the notification.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is a string value representing the request Id of the Notification.</value>
public string RequestId
/// <summary>
/// Gives the value in the type field of the notification.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is an integer value representing the type field of the notification.</value>
public int Type
/// <summary>
/// The ServerResponse structure provides the result and the server response if any.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public struct ServerResponse
{
/// <summary>
/// Enumeration for the Result from the server.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum Result
{
/// <summary>
/// <summary>
/// Gives the Result of the opeartion.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is the Result state of the operation performed.</value>
public Result ServerResult
/// <summary>
/// Gives the Message from the server.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>
/// It is the Message sent by the server.</value>
public string ServerMessage
projects / platform / core / csapi / push.git / commitdiff