Click or drag to resize

MessageDisplayService Class

Service that can display messages to the user
Inheritance Hierarchy

Namespace:  ImmerseSDK.UI.MessageDisplay
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
public class MessageDisplayService : SingletonBehaviour

The MessageDisplayService type exposes the following members.

Constructors
  NameDescription
Public methodMessageDisplayService
Initializes a new instance of the MessageDisplayService class
Top
Properties
  NameDescription
Public propertyIsDisplayingAMessage
Returns true if a message is currently showing, otherwise false
Public propertyMessageCount
Current number of messages
Top
Methods
  NameDescription
Public methodCoroutineInitialise
Override this to perform initialisation tasks This coroutine is started in Awake(). To execute code in Awake(), override OnAwake()
(Overrides SingletonBehaviourCoroutineInitialise.)
Public methodHide
Hide the message specified. Only the message with the highest priority will actually be displayed to the user. It might not be the message you pass into this method.
Protected methodOnDestroy
Unity component method
(Overrides SingletonBehaviourOnDestroy.)
Public methodRefresh
Refreshes the UI and optionally resets the position and orientation
Public methodShow(MessageDisplayDialogData)
Show the message specified. Only the message with the highest priority will actually be displayed to the user. It might not be the message you pass into this method.
Public methodShow(Notification)
Show a message
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also