Module: Twitter::REST::Help

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

Constant Summary

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR, Utils::URI_SUBSTRING

Instance Method Summary (collapse)

Methods included from Utils

flat_pmap, pmap

Instance Method Details

- (Twitter::Configuration) configuration(options = {})

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/help.rb', line 18

def configuration(options = {})
  perform_with_object(:get, '/1.1/help/configuration.json', options, Twitter::Configuration)
end

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

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/help.rb', line 29

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

- (String) privacy(options = {})

Returns:

  • (String)

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



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

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

- (String) tos(options = {})

Returns:

  • (String)

Raises:

See Also:

Rate Limited?:

  • Yes

Authentication:

  • Requires user context



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

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