Class: CPApiRequestAttachmentsList

Inherits:
CPApiRequestBase show all
Defined in:
lib/crowi/client/apireq/api_request_attachments.rb

Overview

添付ファイル一覧リクエスト用クラス

Constant Summary

Constants inherited from CPApiRequestBase

CPApiRequestBase::METHOD_GET, CPApiRequestBase::METHOD_POST

Instance Attribute Summary

Attributes inherited from CPApiRequestBase

#entry_point, #method, #param

Instance Method Summary collapse

Methods inherited from CPApiRequestBase

#invalid?, #valid?, #validation_msg

Constructor Details

#initialize(param = {}) ⇒ CPApiRequestAttachmentsList

コンストラクタ

Parameters:

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

    APIリクエストのパラメータ



10
11
12
 
# File 'lib/crowi/client/apireq/api_request_attachments.rb', line 10

def initialize(param = {})
  super('/_api/attachments.list', METHOD_GET, { page_id: param[:page_id] })
end

Instance Method Details

#execute(entry_point, rest_client_param: {}) ⇒ Array

リクエストを実行する

Parameters:

  • entry_point (String) —

    APIのエントリーポイントとなるURL（ex. localhost:3000/_api/pages.list）

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

    RestClientのパラメータ

Returns:

  • (Array) —

    リクエスト実行結果



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/crowi/client/apireq/api_request_attachments.rb', line 19

def execute(entry_point, rest_client_param: {})
  if invalid?
    return validation_msg
  end
  params = { method: :get, url: entry_point, headers: { params: @param } }.merge(rest_client_param)
  ret = JSON.parse RestClient::Request.execute params
  if (ret['ok'] == false)
    return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
  end
  attachments = []
  ret['attachments'].each do |attachment|
    attachments.push(CrowiAttachment.new(attachment))
  end
  return CPApiReturn.new(ok: ret['ok'], data: attachments)
end