Method: Dnsimple::Client::Tlds#all_tlds

Defined in:
lib/dnsimple/client/tlds.rb

#all_tlds(options = {}) ⇒ Dnsimple::CollectionResponse<Dnsimple::Struct::Tld>

Lists ALL the TLDs in DNSimple.

This method is similar to Dnsimple::Client#tlds, but instead of returning the results of a specific page it iterates all the pages and returns the entire collection.

Please use this method carefully, as fetching the entire collection will increase the number of requests you send to the API server and you may eventually risk to hit the throttle limit.

Examples:

List all TLDs in DNSimple

client.tlds.all

Parameters:

  • options (Hash) (defaults to: {}) —

    the filtering and sorting options

Options Hash (options):

  • :page (Integer) —

    current page (pagination)

  • :per_page (Integer) —

    number of entries to return (pagination)

  • :sort (String) —

    sorting policy

Returns:

Raises:

See Also:



53
54
55
 
# File 'lib/dnsimple/client/tlds.rb', line 53

def all_tlds(options = {})
  paginate(:list_tlds, options)
end