class Twilio::REST::Chat::V1::CredentialList
Public Class Methods
Initialize the CredentialList
@param [Version] version Version
that contains the resource @return [CredentialList] CredentialList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/chat/v1/credential.rb 18 def initialize(version) 19 super(version) 20 21 # Path Solution 22 @solution = {} 23 @uri = "/Credentials" 24 end
Public Instance Methods
Create the CredentialInstance
@param [credential.PushService] type The type of push-notification service the
credential is for. Can be: `gcm`, `fcm`, or `apn`.
@param [String] friendly_name A descriptive string that you create to describe
the new resource. It can be up to 64 characters long.
@param [String] certificate [APN only] The URL encoded representation of the
certificate. For example, `-----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A== -----END CERTIFICATE-----`
@param [String] private_key [APN only] The URL encoded representation of the
private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. -----END RSA PRIVATE KEY-----`
@param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
@param [String] api_key [GCM only] The API key for the project that was obtained
from the Google Developer console for your GCM Service application credential.
@param [String] secret [FCM only] The **Server key** of your project from the
Firebase console, found under Settings / Cloud messaging.
@return [CredentialInstance] Created CredentialInstance
# File lib/twilio-ruby/rest/chat/v1/credential.rb 129 def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) 130 data = Twilio::Values.of({ 131 'Type' => type, 132 'FriendlyName' => friendly_name, 133 'Certificate' => certificate, 134 'PrivateKey' => private_key, 135 'Sandbox' => sandbox, 136 'ApiKey' => api_key, 137 'Secret' => secret, 138 }) 139 140 payload = @version.create('POST', @uri, data: data) 141 142 CredentialInstance.new(@version, payload, ) 143 end
When passed a block, yields CredentialInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/chat/v1/credential.rb 64 def each 65 limits = @version.read_limits 66 67 page = self.page(page_size: limits[:page_size], ) 68 69 @version.stream(page, 70 limit: limits[:limit], 71 page_limit: limits[:page_limit]).each {|x| yield x} 72 end
Retrieve a single page of CredentialInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of CredentialInstance
# File lib/twilio-ruby/rest/chat/v1/credential.rb 98 def get_page(target_url) 99 response = @version.domain.request( 100 'GET', 101 target_url 102 ) 103 CredentialPage.new(@version, response, @solution) 104 end
Lists CredentialInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size 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)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/chat/v1/credential.rb 37 def list(limit: nil, page_size: nil) 38 self.stream(limit: limit, page_size: page_size).entries 39 end
Retrieve a single page of CredentialInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of CredentialInstance
# File lib/twilio-ruby/rest/chat/v1/credential.rb 81 def page(page_token: :unset, page_number: :unset, page_size: :unset) 82 params = Twilio::Values.of({ 83 'PageToken' => page_token, 84 'Page' => page_number, 85 'PageSize' => page_size, 86 }) 87 88 response = @version.page('GET', @uri, params: params) 89 90 CredentialPage.new(@version, response, @solution) 91 end
Streams CredentialInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size 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)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/chat/v1/credential.rb 52 def stream(limit: nil, page_size: nil) 53 limits = @version.read_limits(limit, page_size) 54 55 page = self.page(page_size: limits[:page_size], ) 56 57 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 58 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/chat/v1/credential.rb 147 def to_s 148 '#<Twilio.Chat.V1.CredentialList>' 149 end