Notification.MessagingStyle Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Helper class for generating large-format notifications that include multiple back-and-forth messages of varying types between any number of people.
[Android.Runtime.Register("android/app/Notification$MessagingStyle", ApiSince=24, DoNotGenerateAcw=true)]
public class Notification.MessagingStyle : Android.App.Notification.Style[<Android.Runtime.Register("android/app/Notification$MessagingStyle", ApiSince=24, DoNotGenerateAcw=true)>]
type Notification.MessagingStyle = class
inherit Notification.Style- Inheritance
- Attributes
Remarks
Helper class for generating large-format notifications that include multiple back-and-forth messages of varying types between any number of people. If the platform does not provide large-format notifications, this method has no effect. The user will always see the normal notification view. If the app is targeting Android Build.VERSION_CODES.P and above, it is required to use the Person class in order to get an optimal rendering of the notification and its avatars. For conversations involving multiple people, the app should also make sure that it marks the conversation as a group with setGroupConversation(boolean). From Android Build.VERSION_CODES.UPSIDE_DOWN_CAKE, messaging style notifications that are associated with a valid conversation shortcut (via Notification.Builder.setShortcutId(String)) are displayed in a dedicated conversation section in the shade above non-conversation alerting and silence notifications. To be a valid conversation shortcut, the shortcut must be a ShortcutInfo.Builder.setLongLived(boolean) dynamic or cached sharing shortcut. This class is a "rebuilder": It attaches to a Builder object and modifies its behavior. Here's an example of how this may be used: Note that this style doesn't display the large icon set via Builder.setLargeIcon(Icon), except as a fallback group icon if the shortcut doesn't include one. It can, however, display images set via MessagingStyle.Message.setData.
Android reference for android.app.Notification.MessagingStyle.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
| Name | Description |
|---|---|
| Notification.MessagingStyle(ICharSequence) |
This constructor is deprecated. |
| Notification.MessagingStyle(IntPtr, JniHandleOwnership) |
Initializes a managed representation of an existing Java Native Interface object. |
| Notification.MessagingStyle(Person) | |
| Notification.MessagingStyle(String) |
This constructor is deprecated. |
Fields
| Name | Description |
|---|---|
| MaximumRetainedMessages |
The maximum number of messages that will be retained in the Notification itself (the number displayed is up to the platform). |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| ConversationTitle | |
| ConversationTitleFormatted |
Return the title to be displayed on this conversation. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| HistoricMessages |
Gets the list of historic Messages in the notification. |
| IsGroupConversation |
Returns true if this notification represents a group conversation, otherwise false. |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState | (Inherited from JavaObject) |
| JniPeerMembers |
Provides JNI binding infrastructure for Android.App.Notification.MessagingStyle. |
| MBuilder | (Inherited from Notification.Style) |
| Messages |
Gets the list of Message objects that represent the notification. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| ThresholdClass |
Provides JNI binding infrastructure for Android.App.Notification.MessagingStyle. |
| ThresholdType |
Provides JNI binding infrastructure for Android.App.Notification.MessagingStyle. |
| User | |
| UserDisplayName | |
| UserDisplayNameFormatted |
This method was deprecated in API level 28. |
Methods
| Name | Description |
|---|---|
| AddHistoricMessage(Notification+MessagingStyle+Message) |
Adds a Message for historic context in this notification. |
| AddMessage(ICharSequence, Int64, ICharSequence) |
This method was deprecated in API level 28. |
| AddMessage(ICharSequence, Int64, Person) |
Adds a message for display by this notification. |
| AddMessage(Notification+MessagingStyle+Message) |
Adds a Message for display in this notification. |
| AddMessage(String, Int64, Person) |
Adds a message for display by this notification. |
| AddMessage(String, Int64, String) |
This method was deprecated in API level 28. |
| Build() |
Calls Notification.Builder.build() on the Builder this Style is attached to. (Inherited from Notification.Style) |
| CheckBuilder() | (Inherited from Notification.Style) |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() | (Inherited from JavaObject) |
| Equals(Object) | (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetStandardView(Int32) | (Inherited from Notification.Style) |
| InternalSetBigContentTitle(ICharSequence) |
Overrides ContentTitle in the expanded form of the template. (Inherited from Notification.Style) |
| InternalSetBigContentTitle(String) |
Overrides ContentTitle in the expanded form of the template. (Inherited from Notification.Style) |
| InternalSetSummaryText(ICharSequence) |
Set the first line of text after the detail section in the expanded form of the template. (Inherited from Notification.Style) |
| InternalSetSummaryText(String) |
Set the first line of text after the detail section in the expanded form of the template. (Inherited from Notification.Style) |
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| SetBuilder(Notification+Builder) |
Attaches a |
| SetConversationTitle(ICharSequence) |
Sets the title to be displayed on this conversation. |
| SetConversationTitle(String) |
Sets the title to be displayed on this conversation. |
| SetGroupConversation(Boolean) |
Sets whether this conversation notification represents a group. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() | (Inherited from JavaObject) |
| IJavaPeerable.Finalized() | (Inherited from JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock | (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |