class Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::MessageContext::DeliveryReceiptList
Public Class Methods
Initialize the DeliveryReceiptList
@param [Version] version Version
that contains the resource @param [String] chat_service_sid The SID of the {Conversation
Service}[https://www.twilio.com/docs/conversations/api/service-resource] the Message resource is associated with.
@param [String] conversation_sid The unique ID of the
{Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] for this message.
@param [String] message_sid The SID of the message within a
{Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource] the delivery receipt belongs to
@return [DeliveryReceiptList] DeliveryReceiptList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb 30 def initialize(version, chat_service_sid: nil, conversation_sid: nil, message_sid: nil) 31 super(version) 32 33 # Path Solution 34 @solution = { 35 chat_service_sid: chat_service_sid, 36 conversation_sid: conversation_sid, 37 message_sid: message_sid 38 } 39 @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Messages/#{@solution[:message_sid]}/Receipts" 40 end
Public Instance Methods
When passed a block, yields DeliveryReceiptInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb 80 def each 81 limits = @version.read_limits 82 83 page = self.page(page_size: limits[:page_size], ) 84 85 @version.stream(page, 86 limit: limits[:limit], 87 page_limit: limits[:page_limit]).each {|x| yield x} 88 end
Retrieve a single page of DeliveryReceiptInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of DeliveryReceiptInstance
# File lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb 114 def get_page(target_url) 115 response = @version.domain.request( 116 'GET', 117 target_url 118 ) 119 DeliveryReceiptPage.new(@version, response, @solution) 120 end
Lists DeliveryReceiptInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size 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)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb 53 def list(limit: nil, page_size: nil) 54 self.stream(limit: limit, page_size: page_size).entries 55 end
Retrieve a single page of DeliveryReceiptInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of DeliveryReceiptInstance
# File lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb 97 def page(page_token: :unset, page_number: :unset, page_size: :unset) 98 params = Twilio::Values.of({ 99 'PageToken' => page_token, 100 'Page' => page_number, 101 'PageSize' => page_size, 102 }) 103 104 response = @version.page('GET', @uri, params: params) 105 106 DeliveryReceiptPage.new(@version, response, @solution) 107 end
Streams DeliveryReceiptInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size 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)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb 68 def stream(limit: nil, page_size: nil) 69 limits = @version.read_limits(limit, page_size) 70 71 page = self.page(page_size: limits[:page_size], ) 72 73 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 74 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb 124 def to_s 125 '#<Twilio.Conversations.V1.DeliveryReceiptList>' 126 end