Method: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::InviteList#page

Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb

#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.

Parameters:

  • identity (Array[String]) (defaults to: :unset)

    The [User](www.twilio.com/docs/chat/rest/user-resource)‘s identity value of the resources to read. See [access tokens](www.twilio.com/docs/chat/create-tokens) for more details.

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/invite.rb', line 193

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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