Class: Pinnacle::BasicRcsMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/rcs/types/basic_rcs_message.rb

Overview

The content of the message

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(text:, additional_properties: nil) ⇒ Pinnacle::BasicRcsMessage

Parameters:

  • text (String) —

    The text content of the RCS message

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



22
23
24
25
26
 
# File 'lib/rcs/types/basic_rcs_message.rb', line 22

def initialize(text:, additional_properties: nil)
  @text = text
  @additional_properties = additional_properties
  @_field_set = { "text": text }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



12
13
14
 
# File 'lib/rcs/types/basic_rcs_message.rb', line 12

def additional_properties
  @additional_properties
end

#text ⇒ String (readonly)

Returns The text content of the RCS message.

Returns:

  • (String) —

    The text content of the RCS message



10
11
12
 
# File 'lib/rcs/types/basic_rcs_message.rb', line 10

def text
  @text
end

Class Method Details

.from_json(json_object:) ⇒ Pinnacle::BasicRcsMessage

Deserialize a JSON object to an instance of BasicRcsMessage

Parameters:

  • json_object (String)

Returns:



32
33
34
35
36
37
 
# File 'lib/rcs/types/basic_rcs_message.rb', line 32

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  text = parsed_json["text"]
  new(text: text, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


52
53
54
 
# File 'lib/rcs/types/basic_rcs_message.rb', line 52

def self.validate_raw(obj:)
  obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of BasicRcsMessage to a JSON object

Returns:

  • (String) 


42
43
44
 
# File 'lib/rcs/types/basic_rcs_message.rb', line 42

def to_json(*_args)
  @_field_set&.to_json
end