Class: PlatformLib::FilemanagementService

Inherits:

Object

• Object
• PlatformLib::FilemanagementService

Includes:

ServiceBase

Defined in:

lib/platform_lib/filemanagement_service.rb

Overview

Public: A wrapper around the File Management Business Service

Examples:

# the preferred method 
service = PlatformLib::BusinessService.new("user", "pass").filemanagement_service

# direct instantiation
service = PlatformLib::FileManagementService.new("auth_token")

Constant Summary

END_POINT =

"https://fms.theplatform.com/web/FileManagement"

Instance Method Summary

• #initialize(auth_token) ⇒ FilemanagementService constructor

  Public: Creates a new instance.

• #resetTask(taskId, params) ⇒ Object

  Public: Resets the task end point.

Constructor Details

#initialize(auth_token) ⇒ FilemanagementService

Public: Creates a new instance

auth_token - the authentication token to be used

# File 'lib/platform_lib/filemanagement_service.rb', line 24

def initialize(auth_token)
  @auth_token = auth_token
end

Instance Method Details

#resetTask(taskId, params) ⇒ Object

Public: Resets the task end point

params - an optional hash of parameters (query string) block - an optional block to be called for each item returned

Examples:

resetTask = filemanagement_service.resetTask(taskId, params)

Returns an empty response if successful

# File 'lib/platform_lib/filemanagement_service.rb', line 39

def resetTask(taskId, params)
  data = { :resetTask => { :taskId => taskId } }
  post_data(END_POINT, params, data)
end