lib/yammer/api/message.rb in yammer-client-0.1.2 vs lib/yammer/api/message.rb in yammer-client-0.1.3
- old
+ new
@@ -5,11 +5,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.create_message()
def create_message(opts={})
@@ -19,11 +19,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param id [Integer] the thread ID
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.delete_message
@@ -34,11 +34,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param id [Integer] the thread ID
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.get_message
@@ -49,11 +49,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.all_messages
def all_messages(opts={})
@@ -63,11 +63,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.messages_sent
def messages_sent(opts={})
@@ -77,11 +77,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.messages_received
def messages_received(opts={})
@@ -91,11 +91,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.private_messages
def private_messages(opts={})
@@ -105,11 +105,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.followed_messages
def followed_messages(opts={})
@@ -119,11 +119,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param id [Integer] the thread ID
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.messages_from_user
@@ -134,11 +134,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param id [Integer] the thread ID
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.messages_about_topic
@@ -149,11 +149,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param id [Integer] the thread ID
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.messages_in_group
@@ -164,11 +164,11 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param id [Integer] the thread ID
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.messages_liked_by
@@ -179,10 +179,10 @@
# @see https://developer.yammer.com/restapi/#rest-messages
# @api_path /api/v1/messages
# @rate_limited Yes
# @authentication Requires user context
# @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
- # @return [Yammer::Response]
+ # @return [Yammer::ApiResponse]
# @param id [Integer] the thread ID
# @param [Hash] opts the options to fetch a thread with
# @option opts [Integer] :newer_than
# @example Fetch data for the thread
# Yammer.messages_in_thread
\ No newline at end of file