Included Modules

Class/Module Index [+]

Quicksearch

Twitter::REST::Help

Public Instance Methods

configuration(options = {}) click to toggle source

Returns the current configuration used by Twitter

@see dev.twitter.com/docs/api/1.1/get/help/configuration @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Configuration] Twitter’s configuration.

# File lib/twitter/rest/help.rb, line 18
def configuration(options = {})
  perform_with_object(:get, '/1.1/help/configuration.json', options, Twitter::Configuration)
end
languages(options = {}) click to toggle source

Returns the list of languages supported by Twitter

@see dev.twitter.com/docs/api/1.1/get/help/languages @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Language>]

# File lib/twitter/rest/help.rb, line 29
def languages(options = {})
  perform_with_objects(:get, '/1.1/help/languages.json', options, Twitter::Language)
end
privacy(options = {}) click to toggle source

Returns {twitter.com/privacy Twitter’s Privacy Policy}

@see dev.twitter.com/docs/api/1.1/get/help/privacy @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [String]

# File lib/twitter/rest/help.rb, line 40
def privacy(options = {})
  get('/1.1/help/privacy.json', options).body[:privacy]
end
tos(options = {}) click to toggle source

Returns {twitter.com/tos Twitter’s Terms of Service}

@see dev.twitter.com/docs/api/1.1/get/help/tos @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [String]

# File lib/twitter/rest/help.rb, line 51
def tos(options = {})
  get('/1.1/help/tos.json', options).body[:tos]
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.