MessageDisplayService Class

Service that can display messages to the user

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDKSingletonBehaviour
              ImmerseSDK.UI.MessageDisplayMessageDisplayService

Namespace: ImmerseSDK.UI.MessageDisplay
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)

Syntax

public class MessageDisplayService : SingletonBehaviour

The MessageDisplayService type exposes the following members.

Constructors

	Name	Description
	MessageDisplayService	Initializes a new instance of the MessageDisplayService class

Properties

	Name	Description
	IsDisplayingAMessage	Returns true if a message is currently showing, otherwise false
	MessageCount	Current number of messages

Methods

	Name	Description
	CoroutineInitialise	Override this to perform initialisation tasks This coroutine is started in Awake(). To execute code in Awake(), override OnAwake() (Overrides SingletonBehaviourCoroutineInitialise.)
	Hide	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.
	OnDestroy	Unity component method (Overrides SingletonBehaviourOnDestroy.)
	Refresh	Refreshes the UI and optionally resets the position and orientation
	Show(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.
	Show(Notification)	Show a message

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)