Class: Twilio::REST::Conversations::V1::ParticipantConversationList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Conversations::V1::ParticipantConversationList
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields ParticipantConversationInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ParticipantConversationInstance records from the API.
-
#initialize(version) ⇒ ParticipantConversationList
constructor
Initialize the ParticipantConversationList.
-
#list(identity: :unset, address: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ParticipantConversationInstance records from the API as a list.
-
#page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ParticipantConversationInstance records from the API.
-
#stream(identity: :unset, address: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ ParticipantConversationList
Initialize the ParticipantConversationList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/ParticipantConversations" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields ParticipantConversationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
83 84 85 86 87 88 89 90 91 |
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 83 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 ParticipantConversationInstance records from the API. Request is executed immediately.
121 122 123 124 125 126 127 |
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 121 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ParticipantConversationPage.new(@version, response, @solution) end |
#list(identity: :unset, address: :unset, limit: nil, page_size: nil) ⇒ Array
Lists ParticipantConversationInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
46 47 48 49 50 51 52 53 |
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 46 def list(identity: :unset, address: :unset, limit: nil, page_size: nil) self.stream( identity: identity, address: address, limit: limit, page_size: page_size ).entries end |
#page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ParticipantConversationInstance records from the API. Request is executed immediately.
102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 102 def page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Identity' => identity, 'Address' => address, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) ParticipantConversationPage.new(@version, response, @solution) end |
#stream(identity: :unset, address: :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.
68 69 70 71 72 73 74 75 76 77 |
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 68 def stream(identity: :unset, address: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( identity: identity, address: address, 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
132 133 134 |
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 132 def to_s '#<Twilio.Conversations.V1.ParticipantConversationList>' end |