Class: Twilio::REST::Api::V2010::AccountContext::ConferenceList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/conference.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ ConferenceList

Initialize the ConferenceList

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) (defaults to: nil) —

    The unique id of the Account] responsible for creating this conference.



19
20
21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 19

def initialize(version, account_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      account_sid: 
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/Conferences.json"
end

Instance Method Details

#each ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 108

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 ConferenceInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ConferenceInstance



164
165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 164

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

#list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    Filter by date created

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

    Filter by date created

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

    Filter by date created

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

    Filter by date updated

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

    Filter by date updated

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

    Filter by date updated

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

    Only show results who’s friendly name exactly matches the string

  • status (conference.Status) (defaults to: :unset) —

    A string representing the status of the conference. May be ‘init`, `in-progress`, or `completed`.

  • 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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 50

def list(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil)
  self.stream(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      date_updated_before: date_updated_before,
      date_updated: date_updated,
      date_updated_after: date_updated_after,
      friendly_name: friendly_name,
      status: status,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    Filter by date created

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

    Filter by date created

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

    Filter by date created

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

    Filter by date updated

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

    Filter by date updated

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

    Filter by date updated

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

    Only show results who’s friendly name exactly matches the string

  • status (conference.Status) (defaults to: :unset) —

    A string representing the status of the conference. May be ‘init`, `in-progress`, or `completed`.

  • 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 ConferenceInstance



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 137

def page(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'DateCreated<' => Twilio.serialize_iso8601_date(date_created_before),
      'DateCreated' => Twilio.serialize_iso8601_date(date_created),
      'DateCreated>' => Twilio.serialize_iso8601_date(date_created_after),
      'DateUpdated<' => Twilio.serialize_iso8601_date(date_updated_before),
      'DateUpdated' => Twilio.serialize_iso8601_date(date_updated),
      'DateUpdated>' => Twilio.serialize_iso8601_date(date_updated_after),
      'FriendlyName' => friendly_name,
      'Status' => status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  ConferencePage.new(@version, response, @solution)
end

#stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    Filter by date created

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

    Filter by date created

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

    Filter by date created

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

    Filter by date updated

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

    Filter by date updated

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

    Filter by date updated

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

    Only show results who’s friendly name exactly matches the string

  • status (conference.Status) (defaults to: :unset) —

    A string representing the status of the conference. May be ‘init`, `in-progress`, or `completed`.

  • 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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 86

def stream(date_created_before: :unset, date_created: :unset, date_created_after: :unset, date_updated_before: :unset, date_updated: :unset, date_updated_after: :unset, friendly_name: :unset, status: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      date_created_before: date_created_before,
      date_created: date_created,
      date_created_after: date_created_after,
      date_updated_before: date_updated_before,
      date_updated: date_updated,
      date_updated_after: date_updated_after,
      friendly_name: friendly_name,
      status: status,
      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



174
175
176
 
# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 174

def to_s
  '#<Twilio.Api.V2010.ConferenceList>'
end