service/notification/cpp-wrapper/common/NSMediaContents.h

   1 //******************************************************************\r
   2 //\r
   3 // Copyright 2016 Samsung Electronics All Rights Reserved.\r
   4 //\r
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
   6 //\r
   7 // Licensed under the Apache License, Version 2.0 (the "License");\r
   8 // you may not use this file except in compliance with the License.\r
   9 // You may obtain a copy of the License at\r
  10 //\r
  11 //      http://www.apache.org/licenses/LICENSE-2.0\r
  12 //\r
  13 // Unless required by applicable law or agreed to in writing, software\r
  14 // distributed under the License is distributed on an "AS IS" BASIS,\r
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16 // See the License for the specific language governing permissions and\r
  17 // limitations under the License.\r
  18 //\r
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
  20 \r
  21 /**\r
  22  * @file\r
  23  *\r
  24  * This file contains Notification service media contents representation.\r
  25  */\r
  26 \r
  27 #ifndef _NS_MEDIA_CONTENTS_H_\r
  28 #define _NS_MEDIA_CONTENTS_H_\r
  29 \r
  30 \r
  31 #include <string>\r
  32 #include "NSCommon.h"\r
  33 \r
  34 namespace OIC\r
  35 {\r
  36     namespace Service\r
  37     {\r
  38         /**\r
  39          * @class   NSMediaContents\r
  40          * @brief   This class provides a set of APIs for Notification service Media Contents.\r
  41          */\r
  42         class NSMediaContents\r
  43         {\r
  44             public:\r
  45                 /**\r
  46                      * Constructor of NSMediaContents.\r
  47                      */\r
  48                 NSMediaContents() = default;\r
  49 \r
  50                 /**\r
  51                      * Constructor of NSMediaContents.\r
  52                      *\r
  53                      * @param mediacontents - pointer to NSMediaContents struct to initialize.\r
  54                      */\r
  55                 NSMediaContents(::NSMediaContents *mediacontents);\r
  56 \r
  57                 /**\r
  58                      * Constructor of NSMediaContents.\r
  59                      *\r
  60                      * @param iconImage - iconImage of the Notification service MediaContents.\r
  61                      */\r
  62                 NSMediaContents(const std::string &iconImage)\r
  63                     : m_iconImage(iconImage)\r
  64                 {\r
  65                 }\r
  66 \r
  67 \r
  68                 /**\r
  69                      * Destructor of NSMediaContents.\r
  70                      */\r
  71                 ~NSMediaContents() = default;\r
  72 \r
  73                 /**\r
  74                       * This method is for getting icon image from the Notification service media contents.\r
  75                       *\r
  76                       * @return iconImage as string.\r
  77                       */\r
  78                 std::string getIconImage() const;\r
  79 \r
  80                 /**\r
  81                       * This method is for setting icon image for the Notification service media contents.\r
  82                       *\r
  83                       * @param iconImage - as string.\r
  84                       */\r
  85                 void setIconImage(const std::string &iconImage);\r
  86 \r
  87             private:\r
  88                 std::string m_iconImage;\r
  89 \r
  90         };\r
  91     }\r
  92 }\r
  93 #endif /* _NS_MEDIA_CONTENTS_H_ */\r