Class: Twilio::REST::Chat::V1::ServiceContext::ChannelContext::InviteList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, channel_sid: nil) ⇒ InviteList

Initialize the InviteList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb', line 29

def initialize(version, service_sid: nil, channel_sid: nil)
    super(version)
    # Path Solution
    @solution = { service_sid: service_sid, channel_sid: channel_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Invites"
    
end

Instance Method Details

#create(identity: nil, role_sid: :unset) ⇒ InviteInstance

Create the InviteInstance



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb', line 41

def create(
    identity: nil, 
    role_sid: :unset
)

    data = Twilio::Values.of({
        'Identity' => identity,
        'RoleSid' => role_sid,
    })

    
    payload = @version.create('POST', @uri, data: data)
    InviteInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        channel_sid: @solution[:channel_sid],
    )
end

#each ⇒ Object

When passed a block, yields InviteInstance 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
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.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 InviteInstance records from the API. Request is executed immediately.



145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb', line 145

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

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

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



74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb', line 74

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

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

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



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb', line 126

def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        
        'Identity' =>  Twilio.serialize_list(identity) { |e| e },
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

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

#stream(identity: :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.



94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb', line 94

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

    page = self.page(
        identity: identity,
        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



156
157
158
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb', line 156

def to_s
    '#<Twilio.Chat.V1.InviteList>'
end