Files
notification_ans_standard/kits/native/include/notification_basic_content.h
T
2021-07-15 11:12:35 +08:00

103 lines
3.2 KiB
C++

/*
* Copyright (c); 2021 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");;
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef BASE_NOTIFICATION_ANS_STANDARD_KITS_NATIVE_INCLUDE_NOTIFICATION_BASIC_CONTENT_H
#define BASE_NOTIFICATION_ANS_STANDARD_KITS_NATIVE_INCLUDE_NOTIFICATION_BASIC_CONTENT_H
#include <string>
#include "parcel.h"
namespace OHOS {
namespace Notification {
class NotificationBasicContent : public Parcelable {
public:
/**
* Default deconstructor used to deconstruct.
*/
virtual ~NotificationBasicContent();
/**
* Sets the additional text to be included in a notification.
* The additional text is mainly a supplement to the notification text set by calling setText(std::string).
* The font of the additional text is smaller than the notification text and is displayed in a separate line.
* @param text Indicates the additional text to be included.
*/
virtual void SetAdditionalText(const std::string &additionalText);
/**
* Obtains the additional text of a notification specified by calling setAdditionalText(std::string).
* @return the additional text of the notification.
*/
virtual std::string GetAdditionalText() const;
/**
* Sets the text to be included in a notification.
* @param text Indicates the text to be included.
*/
virtual void SetText(const std::string &text);
/**
* Obtains the text of a notification specified by calling setText(std::string).
* @return the text of the notification.
*/
virtual std::string GetText() const;
/**
* Sets the title of a notification.
* @param title Indicates the title of the notification.
*/
virtual void SetTitle(const std::string &title);
/**
* Obtains the title of a notification specified by calling the setTitle(std::string) method.
* @return the title of the notification.
*/
virtual std::string GetTitle() const;
/**
* Returns a string representation of the object.
* @return a string representation of the object.
*/
virtual std::string Dump();
/**
* Marshal a object into a Parcel.
* @param parcel the object into the parcel
*/
virtual bool Marshalling(Parcel &parcel) const override;
protected:
/**
* Default constructor.
*/
NotificationBasicContent() = default;
/**
* Read data from a Parcel.
* @param parcel the parcel
* @return true if read success; returns false otherwise.
*/
virtual bool ReadFromParcel(Parcel &parcel);
protected:
std::string text_{};
std::string title_{};
std::string additionalText_{};
};
} // namespace Notification
} // namespace OHOS
#endif // BASE_NOTIFICATION_ANS_STANDARD_KITS_NATIVE_INCLUDE_NOTIFICATION_BASIC_CONTENT_H