Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::MemberList

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MemberList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The service_sid

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

    The channel_sid



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 20

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]}/Members"
end

Instance Method Details

#create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset) ⇒ MemberInstance

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

Parameters:

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

    The identity

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

    The role_sid

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

    The last_consumed_message_index

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

    The last_consumption_timestamp

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

    The date_created

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

    The date_updated

Returns:



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

def create(identity: nil, role_sid: :unset, last_consumed_message_index: :unset, last_consumption_timestamp: :unset, date_created: :unset, date_updated: :unset)
  data = Twilio::Values.of({
      'Identity' => identity,
      'RoleSid' => role_sid,
      'LastConsumedMessageIndex' => last_consumed_message_index,
      'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
      'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
      'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  MemberInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      channel_sid: @solution[:channel_sid],
  )
end

#each ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 112

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of MemberInstance



152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 152

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

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

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

Parameters:

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

    The identity

  • 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



77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 77

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

Parameters:

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

    The identity

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 132

def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Identity' => identity,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  MemberPage.new(@version, response, @solution)
end

#stream(identity: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    The identity

  • 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



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 97

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



162
163
164
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/member.rb', line 162

def to_s
  '#<Twilio.Chat.V2.MemberList>'
end