Class: Mediaflux::LogoutRequest

Inherits:
Request
  • Object
show all
Defined in:
app/models/mediaflux/logout_request.rb

Instance Attribute Summary

Attributes inherited from Request

#session_token

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Request

build_post_request, default_xml_namespace, default_xml_namespace_uri, #error?, find_or_create_http_client, format_date_for_mediaflux, request_path, #resolve, #resolved?, #response_body, #response_error, #response_xml, uri, #xml_payload, #xtoshell_xml

Constructor Details

#initialize(session_token:) ⇒ LogoutRequest

Constructor

Parameters:

  • use_ssl (Boolean) —

    determines whether or not connections to the Mediaflux server API are over the TLS/SSL

  • file (File) —

    any upload file required for the POST request

  • session_token (String) —

    the API token for the authenticated session

  • http_client (Net::HTTP) —

    HTTP client for transmitting requests to the Mediaflux server API



9
10
11
 
# File 'app/models/mediaflux/logout_request.rb', line 9

def initialize(session_token:)
  super(session_token: session_token)
end

Class Method Details

.service ⇒ String

Specifies the Mediaflux service to use when logging off

Returns:

  • (String) 


15
16
17
 
# File 'app/models/mediaflux/logout_request.rb', line 15

def self.service
  "system.logoff"
end