Class List Method List File List

# Class: Com::Vmware::Vapi::Std::LocalizableMessage

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vapi::Std::LocalizableMessage
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std.rb

## Overview

The ``Com::Vmware::Vapi::Std::LocalizableMessage`` class represents a localizable string or message template. Classs 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. Classs 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.

## Instance Attribute Summary (collapse)

- - (Array<String>) args

  Arguments to be substituted into a message template.

- - (String) default_message

  The value of this localizable string or message template in the ``en_US`` (English) locale.

- - (String) id

  Unique identifier of the localizable string or message template.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

  Holds (gets or creates) the binding type metadata for this structure type.

## Instance Method Summary (collapse)

- - (LocalizableMessage) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`LocalizableMessage`) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

- ruby_values (`Hash`) (defaults to: `nil`) —

  a map of initial property values (optional)

- struct_value (`VAPI::Data::StructValue`) (defaults to: `nil`) —

  a raw StructValue from the wire (optional)

    137
    138
    139
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std.rb', line 137

    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end

## Instance Attribute Details

### - (`Array<String>`) args

Arguments to be substituted into a message template.

Returns:

- (`Array<String>`)

    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std.rb', line 110

    class LocalizableMessage < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.vapi.std.localizable_message',
                    {
                        'id' => VAPI::Bindings::StringType.instance,
                        'default_message' => VAPI::Bindings::StringType.instance,
                        'args' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    LocalizableMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :default_message,
                      :args

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`String`) default_message

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.

Returns:

- (`String`)

    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std.rb', line 110

    class LocalizableMessage < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.vapi.std.localizable_message',
                    {
                        'id' => VAPI::Bindings::StringType.instance,
                        'default_message' => VAPI::Bindings::StringType.instance,
                        'args' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    LocalizableMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :default_message,
                      :args

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

### - (`String`) id

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.

Returns:

- (`String`)

    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std.rb', line 110

    class LocalizableMessage < VAPI::Bindings::VapiStruct

        class << self
            # Holds (gets or creates) the binding type metadata for this structure type.
            # @scope class
            # @return [VAPI::Bindings::StructType] the binding type
            def binding_type
                @binding_type ||= VAPI::Bindings::StructType.new(
                    'com.vmware.vapi.std.localizable_message',
                    {
                        'id' => VAPI::Bindings::StringType.instance,
                        'default_message' => VAPI::Bindings::StringType.instance,
                        'args' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    },
                    LocalizableMessage,
                    false,
                    nil)
            end
        end

        attr_accessor :id,
                      :default_message,
                      :args

        # Constructs a new instance.
        # @param ruby_values [Hash] a map of initial property values (optional)
        # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
        def initialize(ruby_values=nil, struct_value=nil)
            super(self.class.binding_type, ruby_values, struct_value)
        end
    end

## Class Method Details

### + (`VAPI::Bindings::StructType`) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

- (`VAPI::Bindings::StructType`) —

  the binding type

    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/std.rb', line 116

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vapi.std.localizable_message',
            {
                'id' => VAPI::Bindings::StringType.instance,
                'default_message' => VAPI::Bindings::StringType.instance,
                'args' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
            },
            LocalizableMessage,
            false,
            nil)
    end