Class: Twilio::REST::Api::V2010::AccountContext::CallContext::NotificationList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, call_sid: nil) ⇒ NotificationList

Initialize the NotificationList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 29

def initialize(version, account_sid: nil, call_sid: nil)
    super(version)
    # Path Solution
    @solution = { account_sid: , call_sid: call_sid }
    @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Notifications.json"
    
end

Instance Method Details

#each ⇒ Object

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



95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 95

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



137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 137

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

#list(log: :unset, message_date: :unset, message_date_before: :unset, message_date_after: :unset, limit: nil, page_size: nil) ⇒ Array

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



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 52

def list(log: :unset, message_date: :unset, message_date_before: :unset, message_date_after: :unset, limit: nil, page_size: nil)
    self.stream(
        log: log,
        message_date: message_date,
        message_date_before: message_date_before,
        message_date_after: message_date_after,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(log: :unset, message_date: :unset, message_date_before: :unset, message_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 116

def page(log: :unset, message_date: :unset, message_date_before: :unset, message_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Log' => log,
        'MessageDate' =>  Twilio.serialize_iso8601_date(message_date),
        'MessageDate<' =>  Twilio.serialize_iso8601_date(message_date_before),
        'MessageDate>' =>  Twilio.serialize_iso8601_date(message_date_after),
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

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

#stream(log: :unset, message_date: :unset, message_date_before: :unset, message_date_after: :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.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 78

def stream(log: :unset, message_date: :unset, message_date_before: :unset, message_date_after: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        log: log,
        message_date: message_date,
        message_date_before: message_date_before,
        message_date_after: message_date_after,
        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



148
149
150
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 148

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