Module: Twitter::REST::Help

Includes:

Utils

Included in:

API

Defined in:

lib/twitter/rest/help.rb

Overview

Methods for accessing Twitter help resources

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary

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

  Returns the list of languages supported by Twitter.

• #privacy(options = {}) ⇒ String

  Returns Twitter’s Privacy Policy.

• #tos(options = {}) ⇒ String

  Returns Twitter’s Terms of Service.

Methods included from Utils

flat_pmap, pmap

Instance Method Details

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

Returns the list of languages supported by Twitter

Examples:

client.languages

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/help/languages

# File 'lib/twitter/rest/help.rb', line 21

def languages(options = {})
  perform_get_with_objects("/1.1/help/languages.json", options, Language)
end

#privacy(options = {}) ⇒ String

Returns Twitter’s Privacy Policy

Examples:

client.privacy

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/help/privacy

# File 'lib/twitter/rest/help.rb', line 35

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

#tos(options = {}) ⇒ String

Returns Twitter’s Terms of Service

Examples:

client.tos

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/get/help/tos

# File 'lib/twitter/rest/help.rb', line 49

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