AppNotificationBuilder.SetHeroImage Método

Definición

Sobrecargas

Nombre Description
SetHeroImage(Uri)

Establece la imagen que se muestra en la parte superior de una notificación de aplicación, ocupando el ancho completo de la notificación.

SetHeroImage(Uri, String)

Establece la imagen que se muestra en la parte superior de una notificación de aplicación, ocupando el ancho completo de la notificación, con el texto alternativo especificado.

SetHeroImage(Uri)

Establece la imagen que se muestra en la parte superior de una notificación de aplicación, ocupando el ancho completo de la notificación.

public:
 virtual AppNotificationBuilder ^ SetHeroImage(Uri ^ imageUri) = SetHeroImage;
/// [Windows.Foundation.Metadata.Overload("SetHeroImage")]
AppNotificationBuilder SetHeroImage(Uri const& imageUri);
[Windows.Foundation.Metadata.Overload("SetHeroImage")]
public AppNotificationBuilder SetHeroImage(System.Uri imageUri);
function setHeroImage(imageUri)
Public Function SetHeroImage (imageUri As Uri) As AppNotificationBuilder

Parámetros

imageUri
Uri Uri

Identificador URI del archivo de imagen prominente.

Devoluciones

Devuelve la instancia de AppNotificationBuilder para que se puedan encadenar llamadas de método adicionales.

Atributos

Ejemplos

En el ejemplo siguiente se muestra cómo establecer una imagen de invalidación del logotipo de la aplicación en la carga XML de una notificación de aplicación.

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetHeroImage(new Uri("ms-appx:///Images/HeroImage.png"))
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

La carga XML resultante:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
            <image placement='hero' src='ms-appx:///Images/HeroImage.png'/>
        </binding>
    </visual>
</toast>

Comentarios

En la captura de pantalla siguiente se muestra la ubicación de la imagen prominente.

Captura de pantalla de una notificación de aplicación con una imagen prominente.

Entre los tipos de archivo de imagen admitidos se incluyen:

  • .png
  • .jpg
  • .svg

Para obtener instrucciones sobre cómo usar las API de AppNotificationBuilder para crear la interfaz de usuario para las notificaciones de la aplicación, consulte contenido de notificación de aplicación.

Para obtener información de referencia sobre el esquema XML para las notificaciones de aplicación, consulte esquema de contenido de notificación de aplicación.

Se aplica a

SetHeroImage(Uri, String)

Establece la imagen que se muestra en la parte superior de una notificación de aplicación, ocupando el ancho completo de la notificación, con el texto alternativo especificado.

public:
 virtual AppNotificationBuilder ^ SetHeroImage(Uri ^ imageUri, Platform::String ^ alternateText) = SetHeroImage;
/// [Windows.Foundation.Metadata.Overload("SetHeroImage2")]
AppNotificationBuilder SetHeroImage(Uri const& imageUri, winrt::hstring const& alternateText);
[Windows.Foundation.Metadata.Overload("SetHeroImage2")]
public AppNotificationBuilder SetHeroImage(System.Uri imageUri, string alternateText);
function setHeroImage(imageUri, alternateText)
Public Function SetHeroImage (imageUri As Uri, alternateText As String) As AppNotificationBuilder

Parámetros

imageUri
Uri Uri

Identificador URI del archivo de imagen prominente.

alternateText
String

Platform::String

winrt::hstring

Cadena que contiene el texto alternativo de la imagen principal.

Devoluciones

Devuelve la instancia de AppNotificationBuilder para que se puedan encadenar llamadas de método adicionales.

Atributos

Ejemplos

En el ejemplo siguiente se muestra cómo establecer una imagen de invalidación del logotipo de la aplicación en la carga XML de una notificación de aplicación.

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetHeroImage(new Uri("ms-appx:///Images/HeroImage.png"), "Alternate text")
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

La carga XML resultante:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
            <image placement='hero' src='ms-appx:///Images/HeroImage.png'/>
        </binding>
    </visual>
</toast>

Comentarios

En la captura de pantalla siguiente se muestra la ubicación de la imagen prominente.

Captura de pantalla de una notificación de aplicación con una imagen prominente.

Entre los tipos de archivo de imagen admitidos se incluyen:

  • .png
  • .jpg
  • .svg

Para obtener instrucciones sobre cómo usar las API de AppNotificationBuilder para crear la interfaz de usuario para las notificaciones de la aplicación, consulte contenido de notificación de aplicación.

Para obtener información de referencia sobre el esquema XML para las notificaciones de aplicación, consulte esquema de contenido de notificación de aplicación.

Se aplica a