Module: Twitter::API::Help

Includes:
Utils
Included in:
Client
Defined in:
lib/twitter/api/help.rb

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary collapse

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:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



19
20
21
 
# File 'lib/twitter/api/help.rb', line 19

def configuration(options={})
  object_from_response(Twitter::Configuration, :get, "/1.1/help/configuration.json", options)
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:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



32
33
34
 
# File 'lib/twitter/api/help.rb', line 32

def languages(options={})
  objects_from_response(Twitter::Language, :get, "/1.1/help/languages.json", options)
end

#privacy(options = {}) ⇒ String

Returns Twitter's Privacy Policy

Examples:

Return Twitter's Privacy Policy

Twitter.privacy

Returns:

  • (String)

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



45
46
47
 
# File 'lib/twitter/api/help.rb', line 45

def privacy(options={})
  get("/1.1/help/privacy.json", options)[:body][:privacy]
end

#tos(options = {}) ⇒ String

Returns Twitter's Terms of Service

Examples:

Return Twitter's Terms of Service

Twitter.tos

Returns:

  • (String)

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



58
59
60
 
# File 'lib/twitter/api/help.rb', line 58

def tos(options={})
  get("/1.1/help/tos.json", options)[:body][:tos]
end