Class: Twilio::REST::Conversations::V1::ConversationContext::MessageList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid: nil) ⇒ MessageList

Initialize the MessageList

Parameters:

  • version (Version) —

    Version that contains the resource



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 28

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

Instance Method Details

#create(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, media_sid: :unset, content_sid: :unset, content_variables: :unset, subject: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance

Create the MessageInstance

Parameters:

  • author (String) (defaults to: :unset) —

    The channel specific identifier of the message’s author. Defaults to ‘system`.

  • body (String) (defaults to: :unset) —

    The content of the message, can be up to 1,600 characters long.

  • date_created (Time) (defaults to: :unset) —

    The date that this resource was created.

  • date_updated (Time) (defaults to: :unset) —

    The date that this resource was last updated. ‘null` if the message has not been edited.

  • attributes (String) (defaults to: :unset) —

    A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set \"{}\" will be returned.

  • media_sid (String) (defaults to: :unset) —

    The Media SID to be attached to the new Message.

  • content_sid (String) (defaults to: :unset) —

    The unique ID of the multi-channel [Rich Content](www.twilio.com/docs/content) template, required for template-generated messages. Note that if this field is set, ‘Body` and `MediaSid` parameters are ignored.

  • content_variables (String) (defaults to: :unset) —

    A structurally valid JSON string that contains values to resolve Rich Content template variables.

  • subject (String) (defaults to: :unset) —

    The subject of the message, can be up to 256 characters long.

  • x_twilio_webhook_enabled (ConversationMessageEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 48

def create(
    author: :unset, 
    body: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    media_sid: :unset, 
    content_sid: :unset, 
    content_variables: :unset, 
    subject: :unset, 
    x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'Author' => author,
        'Body' => body,
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'Attributes' => attributes,
        'MediaSid' => media_sid,
        'ContentSid' => content_sid,
        'ContentVariables' => content_variables,
        'Subject' => subject,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    MessageInstance.new(
        @version,
        payload,
        conversation_sid: @solution[:conversation_sid],
    )
end

#each ⇒ Object

When passed a block, yields MessageInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 134

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of MessageInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MessageInstance



173
174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 173

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
MessagePage.new(@version, response, @solution)
end

#list(order: :unset, limit: nil, page_size: nil) ⇒ Array

Lists MessageInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • order (OrderType) (defaults to: :unset) —

    The sort order of the returned messages. Can be: ‘asc` (ascending) or `desc` (descending), with `asc` as the default.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 100

def list(order: :unset, limit: nil, page_size: nil)
    self.stream(
        order: order,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(order: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of MessageInstance records from the API. Request is executed immediately.

Parameters:

  • order (OrderType) (defaults to: :unset) —

    The sort order of the returned messages. Can be: ‘asc` (ascending) or `desc` (descending), with `asc` as the default.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of MessageInstance



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 152

def page(order: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Order' => order,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    MessagePage.new(@version, response, @solution)
end

#stream(order: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • order (OrderType) (defaults to: :unset) —

    The sort order of the returned messages. Can be: ‘asc` (ascending) or `desc` (descending), with `asc` as the default.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



120
121
122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 120

def stream(order: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        order: order,
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



184
185
186
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 184

def to_s
    '#<Twilio.Conversations.V1.MessageList>'
end