Com::Vmware::Vapi::Std::LocalizableMessage Class Reference

Inheritance diagram for Com::Vmware::Vapi::Std::LocalizableMessage:

Avaliable Methods
public method	set_default_message ()
public method	get_id ()
public method	set_args ()
public method	get_args ()
public method	get_default_message ()
public method	set_id ()
public method	new ()

Detailed Description

The Com::Vmware::Vapi::Std::LocalizableMessage class represents a localizable string or message template. Interfaces include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Interfaces can include localizable strings in the data returned from methods to allow clients to display localized status information in the native language of the user.

Member Function Documentation

public method Com::Vmware::Vapi::Std::LocalizableMessage::get_args

(

)

Gets the value of 'args' property.

Return values

args	- The current value of the field. Arguments to be substituted into a message template. List#

Code:

public method Com::Vmware::Vapi::Std::LocalizableMessage::get_default_message

(

)

Gets the value of 'default_message' property.

Return values

default_message

- The current value of the field. The value of this localizable string or message template in the en_US (English) locale. If :attr:Com::Vmware::Vapi::Std::LocalizableMessage.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. String#

Code:

public method Com::Vmware::Vapi::Std::LocalizableMessage::get_id

(

)

Gets the value of 'id' property.

Return values

id	- The current value of the field. Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

String#

Code:

public method Com::Vmware::Vapi::Std::LocalizableMessage::new

(

)

Constructor to initialize the Com::Vmware::Vapi::Std::LocalizableMessage structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vapi::Std::LocalizableMessage::set_args

(

)

Sets the given value for 'args' property.

Parameters

args	- New value for the field. Arguments to be substituted into a message template.

Code:

public method Com::Vmware::Vapi::Std::LocalizableMessage::set_default_message

(

)

Sets the given value for 'default_message' property.

Parameters

default_message

- New value for the field. The value of this localizable string or message template in the en_US (English) locale. If :attr:Com::Vmware::Vapi::Std::LocalizableMessage.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

Code:

public method Com::Vmware::Vapi::Std::LocalizableMessage::set_id

(

)

Sets the given value for 'id' property.

Parameters

id	- New value for the field. Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vapi/Std/LocalizableMessage.pm