module Croudia::Rest::Mutes::Users

Public Instance Methods

mute(params = {}) click to toggle source

Mutes the user specified in the ID parameter for the authenticating user.

@see developer.croudia.com/docs/71_mutes_users_create @return [Croudia::Object::User] Muted user. @param params [Hash] A customized options. @option params [String] :screen_name The screen name of the potentially muted user. @option params [Integer] :user_id The ID of the potentially muted user.

# File lib/croudia/rest/mutes/users.rb, line 17
def mute(params = {})
  response = post('mutes/users/create.json', params)
  Croudia::Object::User.new(response)
end
mute_ids(params = {}) click to toggle source

Returns an array of numeric user ids the authenticating user has muted.

@see developer.croudia.com/docs/75_mutes_users_ids @return [Croudia::Object::IDs] Numeric user ids the authenticating user has muted. @param params [Hash] A customized options. @option params [Integer] :cursor The page cursor.

# File lib/croudia/rest/mutes/users.rb, line 51
def mute_ids(params = {})
  response = get('mutes/users/ids.json', params)
  Croudia::Object::IDs.new(response)
end
mutes(params = {}) click to toggle source

Returns a collection of users the authenticating user has muted.

@see developer.croudia.com/docs/74_mutes_users_list @param params [Hash] A customized options. @option params [Integer] :cursor The page cursor. @option params [Boolean] :trim_user When set to true, objects returned will include a user object including only the status authors numerical ID.

# File lib/croudia/rest/mutes/users.rb, line 40
def mutes(params = {})
  response = get('mutes/users/list.json', params)
  Croudia::Object::List.new(response)
end
umnute(params = {}) click to toggle source

Un-mutes the user specified in the ID parameter for the authenticating user.

@see developer.croudia.com/docs/72_mutes_users_destroy @return [Croudia::Object::User] Un-muted user. @param params [Hash] A customized options. @option params [String] :screen_name The screen name of the potentially unmuted user. @option params [Integer] :user_id The ID of the potentially unmuted user.

# File lib/croudia/rest/mutes/users.rb, line 29
def umnute(params = {})
  response = post('mutes/users/destroy.json', params)
  Croudia::Object::User.new(response)
end