class GApiRequestAttachmentsList

添付ファイル一覧リクエスト用クラス @ref github.com/growi/growi/blob/master/lib/routes/attachment.js

Public Class Methods

new(param = {}) click to toggle source

コンストラクタ @override @param [Hash] param APIリクエストのパラメータ

Calls superclass method GApiRequestBase::new
# File lib/growi/client/apireq/api_request_attachments.rb, line 10
def initialize(param = {})
  super('/_api/attachments.list', METHOD_GET, { page_id: param[:page_id] })
end

Public Instance Methods

execute(entry_point, rest_client_param: {}) click to toggle source

リクエストを実行する @override @param [String] entry_point APIのエントリーポイントとなるURL(ex. localhost:3000/_api/pages.list) @param [Hash] rest_client_param RestClientのパラメータ @return [Array] リクエスト実行結果

# File lib/growi/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 GCInvalidRequest.new "API return false with msg: #{ret['msg']}"
  end
  attachments = []
  ret['attachments'].each do |attachment|
    attachments.push(GrowiAttachment.new(attachment))
  end
  return GApiReturn.new(ok: ret['ok'], data: attachments)
end

Protected Instance Methods

_invalid() click to toggle source

バリデーションエラーを取得する @return [nil/GCInvalidRequest] バリデーションエラー結果

# File lib/growi/client/apireq/api_request_attachments.rb, line 39
def _invalid
  if ! (@param[:page_id])
    GCInvalidRequest.new 'Parameter page_id is required.'
  end
end