src/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs

   1 /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18 using System.Collections.Generic;
  19 using System.Linq;
  20 using System.Text;
  21 using System.Threading.Tasks;
  22
  23 namespace Tizen.Applications
  24 {
  25     /// <summary>
  26     /// The class helps you create and show ToastMessage which is a view quick message for the user
  27     /// </summary>
  28     public sealed class ToastMessage
  29     {
  30
  31         /// <summary>
  32         /// Gets and sets message to post ToastMessage
  33         /// </summary>
  34         public string Message { get; set; }
  35
  36         /// <summary>
  37         /// Posts a message on a toast popup
  38         /// </summary>
  39         /// <exception cref="ArgumentNullException">Thrown when Message is null</exception>
  40         /// <example>
  41         /// <code>
  42         /// ToastMessage toast = new ToastMessage
  43         /// {
  44         ///     Message = "Hello TIzen"
  45         /// };
  46         /// toast.Post();
  47         /// </code>
  48         /// </example>
  49         public void Post()
  50         {
  51             int ret = Interop.ToastMessage.ToastMessagePost(Message);
  52             if (ret != (int)ToastMessageError.None)
  53             {
  54                 throw ToastMessageErrorFactory.GetException((ToastMessageError)ret, "post toast message failed");
  55             }
  56         }
  57     }
  58
  59 }