Module: Twitter::Client::Help

Included in:

Twitter::Client

Defined in:

lib/twitter/client/help.rb

Overview

Defines methods related twitter's supported features and configuration

Instance Method Summary

• #configuration(options = {}) ⇒ Twitter::Configuration

  Returns the current configuration used by Twitter.

• #languages(options = {}) ⇒ Array<Twitter::Language>

  Returns the list of languages supported by Twitter.

Instance Method Details

#configuration(options = {}) ⇒ Twitter::Configuration

Returns the current configuration used by Twitter

Examples:

Return the current configuration used by Twitter

Twitter.configuration

Returns:

• (Twitter::Configuration) —

  Twitter's configuration.

See Also:

• https://dev.twitter.com/docs/api/1/get/help/configuration

Rate Limited?:

• Yes

Requires Authentication?:

• No

# File 'lib/twitter/client/help.rb', line 17

def configuration(options={})
  configuration = get("/1/help/configuration.json", options)
  Twitter::Configuration.new(configuration)
end

#languages(options = {}) ⇒ Array<Twitter::Language>

Returns the list of languages supported by Twitter

Examples:

Return the list of languages Twitter supports

Twitter.languages

Returns:

• (Array<Twitter::Language>)

See Also:

• https://dev.twitter.com/docs/api/1/get/help/languages

Rate Limited?:

• Yes

Requires Authentication?:

• No

# File 'lib/twitter/client/help.rb', line 30

def languages(options={})
  get("/1/help/languages.json", options).map do |language|
    Twitter::Language.new(language)
  end
end