Class: Twilio::REST::Sync::V1::ServiceContext::SyncStreamContext::StreamMessageList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, stream_sid: nil) ⇒ StreamMessageList

Initialize the StreamMessageList

Parameters:

  • version (Version) —

    Version that contains the resource



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb', line 29

def initialize(version, service_sid: nil, stream_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { service_sid: service_sid, stream_sid: stream_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Streams/#{@solution[:stream_sid]}/Messages"
    
end

Instance Method Details

#create(data: nil) ⇒ StreamMessageInstance

Create the StreamMessageInstance

Parameters:

  • data (Object) (defaults to: nil) —

    A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4 KiB in length.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb', line 41

def create(
    data: nil
)

    data = Twilio::Values.of({
        'Data' => Twilio.serialize_object(data),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    StreamMessageInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        stream_sid: @solution[:stream_sid],
    )
end

#create_with_metadata(data: nil) ⇒ StreamMessageInstance

Create the StreamMessageInstanceMetadata

Parameters:

  • data (Object) (defaults to: nil) —

    A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4 KiB in length.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb', line 68

def create_with_metadata(
  data: nil
)

    data = Twilio::Values.of({
        'Data' => Twilio.serialize_object(data),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    stream_message_instance = StreamMessageInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        stream_sid: @solution[:stream_sid],
    )
    StreamMessageInstanceMetadata.new(
        @version,
        stream_message_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



101
102
103
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream/stream_message.rb', line 101

def to_s
    '#<Twilio.Sync.V1.StreamMessageList>'
end