docs.unity3d.com
    Show / Hide Table of Contents

    Interface IGameNotification

    Represents a notification that will be delivered for this application.

    Namespace: NotificationSamples
    Syntax
    public interface IGameNotification

    Properties

    BadgeNumber

    Gets or sets the badge number for this notification. No badge number will be shown if null.

    Declaration
    int? BadgeNumber { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    The number displayed on the app badge.

    Body

    Gets or sets the body text of the notification.

    Declaration
    string Body { get; set; }
    Property Value
    Type Description
    String

    The body message for the notification.

    Data

    Gets or sets optional arbitrary data for the notification.

    Declaration
    string Data { get; set; }
    Property Value
    Type Description
    String

    DeliveryTime

    Gets or sets time to deliver the notification.

    Declaration
    DateTime? DeliveryTime { get; set; }
    Property Value
    Type Description
    Nullable<DateTime>

    The time of delivery in local time.

    Group

    Gets or sets group to which this notification belongs.

    Declaration
    string Group { get; set; }
    Property Value
    Type Description
    String

    A platform specific string identifier for the notification's group.

    Id

    Gets or sets a unique identifier for this notification.

    Declaration
    int? Id { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    A unique integer identifier for this notification, or null (on some platforms) if not explicitly set.

    Remarks

    If null, will be generated automatically once the notification is delivered, and then can be retrieved afterwards.

    On some platforms, this might be converted to a string identifier internally.

    LargeIcon

    Notification large icon.

    Declaration
    string LargeIcon { get; set; }
    Property Value
    Type Description
    String

    Scheduled

    Gets whether this notification has been scheduled.

    Declaration
    bool Scheduled { get; }
    Property Value
    Type Description
    Boolean

    True if the notification has been scheduled with the underlying operating system.

    ShouldAutoCancel

    Gets or sets if this notification will be dismissed automatically when the user taps it. Only available on Android.

    Declaration
    bool ShouldAutoCancel { get; set; }
    Property Value
    Type Description
    Boolean

    SmallIcon

    Notification small icon.

    Declaration
    string SmallIcon { get; set; }
    Property Value
    Type Description
    String

    Subtitle

    Gets or sets a subtitle for the notification.

    Declaration
    string Subtitle { get; set; }
    Property Value
    Type Description
    String

    The subtitle message for the notification.

    Title

    Gets or sets the notification's title.

    Declaration
    string Title { get; set; }
    Property Value
    Type Description
    String

    The title message for the notification.

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023