Class MessageDialogSystem.OpenMsgDialogRequest

Open message dialog

Inheritance
Object
Request
MessageDialogSystem.OpenMsgDialogRequest
Inherited Members
Namespace: Unity.PSN.PS5.Dialogs
Syntax
public class OpenMsgDialogRequest : Request

Properties

Mode

The type of message mode

Declaration
public MessageDialogSystem.OpenMsgDialogRequest.MsgModes Mode { get; set; }
Property Value
Type Description
MessageDialogSystem.OpenMsgDialogRequest.MsgModes

ProgressBar

Settings for progress bar. Only used when Mode is ProgressBar

Declaration
public MessageDialogSystem.ProgressBarParams ProgressBar { get; set; }
Property Value
Type Description
MessageDialogSystem.ProgressBarParams

ProgressValue

Current progress of the bar.

Declaration
public uint ProgressValue { get; }
Property Value
Type Description
UInt32

SelectedButton

ID of the button selected by the user

Declaration
public MessageDialogSystem.OpenMsgDialogRequest.ButtonResultTypes SelectedButton { get; }
Property Value
Type Description
MessageDialogSystem.OpenMsgDialogRequest.ButtonResultTypes

Status

The Status of the dialog

Declaration
public DialogSystem.DialogStatus Status { get; }
Property Value
Type Description
DialogSystem.DialogStatus

SystemMsg

Settings for system messages. Only used when Mode is SystemMsg

Declaration
public MessageDialogSystem.SystemMsgParams SystemMsg { get; set; }
Property Value
Type Description
MessageDialogSystem.SystemMsgParams

UserId

User ID

Declaration
public int UserId { get; set; }
Property Value
Type Description
Int32

UserMsg

Settings for User messages. Only used when Mode is UserMsg

Declaration
public MessageDialogSystem.UserMsgParams UserMsg { get; set; }
Property Value
Type Description
MessageDialogSystem.UserMsgParams

Methods

CloseDialog()

Close the dialog when it is open or just before being opened. Call this if the request has already been scheduled.

Declaration
public void CloseDialog()

HasUpdate()

Declaration
protected override bool HasUpdate()
Returns
Type Description
Boolean
Overrides

IncProgressBar(UInt32)

Increment the progress bar by a percentage delta

Declaration
public void IncProgressBar(uint delta)
Parameters
Type Name Description
UInt32 delta

The number of percentage points to increment

Reset()

Reset the request so it can be used again. Don't call this when the request has been scheduled.

Declaration
public void Reset()

Run()

Declaration
protected override void Run()
Overrides

SetProgressBarMessage(String)

Set the progress bar message

Declaration
public void SetProgressBarMessage(string message)
Parameters
Type Name Description
String message

SetProgressBarValue(UInt32)

Set the progress bar value

Declaration
public void SetProgressBarValue(uint rate)
Parameters
Type Name Description
UInt32 rate

The value of the progress bar

Update()

Declaration
protected override bool Update()
Returns
Type Description
Boolean
Overrides