public class Message
extends java.lang.Object
Constructor and Description |
---|
Message() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getFormat()
A format string for the message.
|
int |
getId()
Unique identifier for the message.
|
java.lang.Boolean |
getSendTelemetry()
If true send to telemetry.
|
java.lang.Boolean |
getShowUser()
If true show user.
|
java.lang.String |
getUrl()
An optional url where additional information about this message can be found.
|
java.lang.String |
getUrlLabel()
An optional label that is presented to the user as the UI for opening the url.
|
java.util.Map<java.lang.String,java.lang.String> |
getVariables()
An object used as a dictionary for looking up the variables in the format string.
|
int |
hashCode() |
void |
setFormat(java.lang.String format)
A format string for the message.
|
void |
setId(int id)
Unique identifier for the message.
|
void |
setSendTelemetry(java.lang.Boolean sendTelemetry)
If true send to telemetry.
|
void |
setShowUser(java.lang.Boolean showUser)
If true show user.
|
void |
setUrl(java.lang.String url)
An optional url where additional information about this message can be found.
|
void |
setUrlLabel(java.lang.String urlLabel)
An optional label that is presented to the user as the UI for opening the url.
|
void |
setVariables(java.util.Map<java.lang.String,java.lang.String> variables)
An object used as a dictionary for looking up the variables in the format string.
|
java.lang.String |
toString() |
@Pure public int getId()
public void setId(int id)
@Pure public java.lang.String getFormat()
If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.
public void setFormat(java.lang.String format)
If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.
@Pure public java.util.Map<java.lang.String,java.lang.String> getVariables()
This is an optional property.
public void setVariables(java.util.Map<java.lang.String,java.lang.String> variables)
This is an optional property.
@Pure public java.lang.Boolean getSendTelemetry()
This is an optional property.
public void setSendTelemetry(java.lang.Boolean sendTelemetry)
This is an optional property.
@Pure public java.lang.Boolean getShowUser()
This is an optional property.
public void setShowUser(java.lang.Boolean showUser)
This is an optional property.
@Pure public java.lang.String getUrl()
This is an optional property.
public void setUrl(java.lang.String url)
This is an optional property.
@Pure public java.lang.String getUrlLabel()
This is an optional property.
public void setUrlLabel(java.lang.String urlLabel)
This is an optional property.
@Pure public java.lang.String toString()
toString
in class java.lang.Object
@Pure public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
@Pure public int hashCode()
hashCode
in class java.lang.Object