class CPApiRequestPagesSeen

ページ閲覧済マークを付与リクエスト用クラス @ref github.com/crowi/crowi/blob/master/lib/routes/page.js @note 詳細不明

Public Class Methods

new(param = {}) click to toggle source

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

Calls superclass method CPApiRequestBase::new
# File lib/crowi/client/apireq/api_request_pages.rb, line 203
def initialize(param = {})
  super('/_api/pages.seen', METHOD_POST, { 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/crowi/client/apireq/api_request_pages.rb, line 212
def execute(entry_point, rest_client_param: {})

  if invalid?
    return validation_msg
  end
  params = { method: :post, url: entry_point,
             payload: @param.to_json,
             headers: { content_type: :json, accept: :json }
           }.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
  return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['seenUser']))
end

Protected Instance Methods

_invalid() click to toggle source

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

# File lib/crowi/client/apireq/api_request_pages.rb, line 233
def _invalid
  if ! (@param[:page_id]) 
    return CPInvalidRequest.new 'Parameter page_id required.'
  end
end