NotificationRequest.NotificationPictureContent

java.lang.Object
- ohos.event.notification.NotificationRequest.NotificationPictureContent

所有已实现的接口:: Sequenceable

封闭类:: NotificationRequest

public static final class NotificationRequest.NotificationPictureContent
extends Object
implements Sequenceable

Constructs notifications that include a picture attachment.

This class is used with NotificationContent and NotificationRequest. Example code:

 NotificationRequest request = new NotificationRequest();
 NotificationPictureContent pictureContent = new NotificationPictureContent();
 NotificationContent notificationContent = new NotificationContent(pictureContent);
 request.setContent(notificationContent);

从以下版本开始:: 1
另请参阅:: NotificationRequest, NotificationRequest.NotificationContent
SystemCapability: SystemCapability.Notification#ANS

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

构造器概要

构造器
构造器说明

NotificationPictureContent()
Default constructor used to create an empty NotificationPictureContent instance.

构造器
构造器	说明
`NotificationPictureContent()`	Default constructor used to create an empty `NotificationPictureContent` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`String`	`getAdditionalText()`	Obtains the additional text of a picture-attached notification specified by calling the `setAdditionalText(java.lang.String)` method.
`PixelMap`	`getBigPicture()`	Obtains the `PixelMap` of the picture specified by calling the `setBigPicture(ohos.media.image.PixelMap)` method.
`String`	`getBriefText()`	Obtains the brief text of a picture-attached notification specified by calling the `setBriefText(java.lang.String)` method.
`String`	`getExpandedTitle()`	Obtains the title that will be displayed for this picture-attached notification when it is expanded.
`String`	`getText()`	Obtains the text of a picture-attached notification specified by calling the `setText(java.lang.String)` method.
`String`	`getTitle()`	Obtains the title of a picture-attached notification specified by calling the `setTitle(java.lang.String)` method.
`boolean`	`marshalling(Parcel out)`	Marshals a `NotificationPictureContent` object into a `Parcel`.
`NotificationRequest.NotificationPictureContent`	`setAdditionalText(String additionalText)`	Sets the additional text to be included in a picture-attached notification.
`NotificationRequest.NotificationPictureContent`	`setBigPicture(PixelMap bigPicture)`	Sets the picture to be included in a notification.
`NotificationRequest.NotificationPictureContent`	`setBriefText(String briefText)`	Sets the brief text to be included in a picture-attached notification.
`NotificationRequest.NotificationPictureContent`	`setExpandedTitle(String expandedTitle)`	Sets the title to be displayed when this picture-attached notification is expanded.
`NotificationRequest.NotificationPictureContent`	`setText(String text)`	Sets the text to be included in a picture-attached notification.
`NotificationRequest.NotificationPictureContent`	`setTitle(String title)`	Sets the title of a picture-attached notification.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals a `NotificationPictureContent` object from a `Parcel`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 构造器详细资料
  - NotificationPictureContent
```
public NotificationPictureContent()
```
    Default constructor used to create an empty NotificationPictureContent instance.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - getTitle
```
public String getTitle()
```
    Obtains the title of a picture-attached notification specified by calling the setTitle(java.lang.String) method.
    
    返回:
    
    Returns the title of the notification.
    
    从以下版本开始:
    
    1
  - setTitle
```
public NotificationRequest.NotificationPictureContent setTitle(String title)
```
    Sets the title of a picture-attached notification.
    
    参数:
    
    title - Indicates the title of the notification.
    
    返回:
    
    Returns the NotificationPictureContent object with the specified title.
    
    从以下版本开始:
    
    1
  - getText
```
public String getText()
```
    Obtains the text of a picture-attached notification specified by calling the setText(java.lang.String) method.
    
    返回:
    
    Returns the text of the notification.
    
    从以下版本开始:
    
    1
  - setText
```
public NotificationRequest.NotificationPictureContent setText(String text)
```
    Sets the text to be included in a picture-attached notification.
    
    参数:
    
    text - Indicates the text to be included.
    
    返回:
    
    Returns the NotificationPictureContent object with the specified text.
    
    从以下版本开始:
    
    1
  - getAdditionalText
```
public String getAdditionalText()
```
    Obtains the additional text of a picture-attached notification specified by calling the setAdditionalText(java.lang.String) method.
    
    返回:
    
    Returns the additional text of the picture-attached notification.
    
    从以下版本开始:
    
    2
  - setAdditionalText
```
public NotificationRequest.NotificationPictureContent setAdditionalText(String additionalText)
```
    Sets the additional text to be included in a picture-attached notification.
    The additional text is mainly a supplement to the notification text. Therefore, the font of the additional text is smaller than the notification text and is displayed in a separate line.
    
    参数:
    
    additionalText - Indicates the additional text to be included.
    
    返回:
    
    Returns the NotificationPictureContent object with the specified additionalText.
    
    从以下版本开始:
    
    2
  - getBriefText
```
public String getBriefText()
```
    Obtains the brief text of a picture-attached notification specified by calling the setBriefText(java.lang.String) method.
    
    返回:
    
    Returns the brief text of the picture-attached notification.
    
    从以下版本开始:
    
    2
  - setBriefText
```
public NotificationRequest.NotificationPictureContent setBriefText(String briefText)
```
    Sets the brief text to be included in a picture-attached notification.
    The brief text is a summary of a picture-attached notification and is displayed in the first line of the notification. Similar to setAdditionalText(java.lang.String), the font of the brief text is also smaller than the notification text.
    The positions where the brief text and additional text will display may conflict. If both texts are set, only the additional text will be displayed.
    
    参数:
    
    briefText - Indicates the brief text to be included.
    
    返回:
    
    Returns the NotificationPictureContent object with the specified briefText.
    
    从以下版本开始:
    
    2
  - getExpandedTitle
```
public String getExpandedTitle()
```
    Obtains the title that will be displayed for this picture-attached notification when it is expanded.
    
    返回:
    
    Returns the title to be displayed when this notification is expanded.
    
    从以下版本开始:
    
    3
  - setExpandedTitle
```
public NotificationRequest.NotificationPictureContent setExpandedTitle(String expandedTitle)
```
    Sets the title to be displayed when this picture-attached notification is expanded. After this title is set, the title set by setTitle(java.lang.String) will be displayed only when this notification is in the collapsed state.
    
    参数:
    
    expandedTitle - Indicates the title to be displayed when this notification is expanded.
    
    返回:
    
    Returns this NotificationPictureContent object with the specified expandedTitle.
    
    从以下版本开始:
    
    3
  - setBigPicture
```
public NotificationRequest.NotificationPictureContent setBigPicture(PixelMap bigPicture)
```
    Sets the picture to be included in a notification.
    
    参数:
    
    bigPicture - Indicates the PixelMap of the picture to be included.
    
    返回:
    
    Returns the NotificationPictureContent object with the specified bigPicture.
    
    从以下版本开始:
    
    3
  - getBigPicture
```
public PixelMap getBigPicture()
```
    Obtains the PixelMap of the picture specified by calling the setBigPicture(ohos.media.image.PixelMap) method.
    
    返回:
    
    Returns the PixelMap of the picture included in the notification.
    
    从以下版本开始:
    
    3
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals a NotificationPictureContent object into a Parcel.
    A process can call the unmarshalling(ohos.utils.Parcel) method to unmarshal a NotificationPictureContent object from a Parcel to implement inter-process communication (IPC).
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshals a NotificationPictureContent object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
    
    从以下版本开始:
    
    4

类 NotificationRequest.NotificationPictureContent

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

构造器详细资料

NotificationPictureContent

方法详细资料

getTitle

setTitle

getText

setText

getAdditionalText

setAdditionalText

getBriefText

setBriefText

getExpandedTitle

setExpandedTitle

setBigPicture

getBigPicture

marshalling

unmarshalling

toString