Method: EsiClient::CharacterApi#get_characters_character_id_chat_channels_with_http_info

Defined in:
lib/esi-ruby/api/character_api.rb

#get_characters_character_id_chat_channels_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdChatChannels200Ok>, Fixnum, Hash)>

Get chat channels Return chat channels that a character is the owner or an operator of — Alternate route: &#x60;/v1/characters/character_id/chat_channels/&#x60; Alternate route: &#x60;/legacy/characters/character_id/chat_channels/&#x60; Alternate route: &#x60;/dev/characters/character_id/chat_channels/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/esi-ruby/api/character_api.rb', line 240

def get_characters_character_id_chat_channels_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_chat_channels ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_chat_channels" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/chat_channels/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdChatChannels200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_chat_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end