Module: Twitter::REST::API::Help

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

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR, Utils::URI_SUBSTRING

Instance Method Summary collapse

Instance Method Details

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

Returns the current configuration used by Twitter

Returns:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



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

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

Returns:

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



29
30
31
 
# File 'lib/twitter/rest/api/help.rb', line 29

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

#privacy(options = {}) ⇒ String

Returns Twitter's Privacy Policy

Returns:

  • (String)

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



40
41
42
 
# File 'lib/twitter/rest/api/help.rb', line 40

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

#tos(options = {}) ⇒ String

Returns Twitter's Terms of Service

Returns:

  • (String)

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



51
52
53
 
# File 'lib/twitter/rest/api/help.rb', line 51

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