Module: Yammer::Api::Search

Included in:

Client

Defined in:

lib/yammer/api/search.rb

Instance Method Summary

• #search(opts = {}) ⇒ Yammer::ApiResponse

Instance Method Details

#search(opts = {}) ⇒ Yammer::ApiResponse

Examples:

Search for a particular term on within current user's network

Yammer.search(:search => 'documents')

Parameters:

• opts (Hash) (defaults to: {}) —

  the options to fetch a thread with

Options Hash (opts):

• :num_per_page (Integer)
• :page (Integer)
• :search_group (Integer)
• :search_user (Integer)
• :search_sort (String)
• :match (String)
• :model_types (String)
• :search_startdate (String)
• :search_enddate (String)

Returns:

• (Yammer::ApiResponse)

Raises:

• (Yammer::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.yammer.com/restapi/#rest-search

Rest API path:

• /api/v1/search

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/yammer/api/search.rb', line 23

def search(opts={})
  get('/api/v1/search', opts)
end