Method: ChatWork::Client::FileMethods#find_file

Defined in:

lib/chatwork/client/file_methods.rb

#find_file(room_id:, file_id:, create_download_url: nil) {|response_body, response_header| ... } ⇒ Hashie::Mash

Get information about the specified file

Examples:

response format

{
  "file_id":3,
  "account": {
    "account_id":123,
    "name":"Bob",
    "avatar_image_url": "https://example.com/ico_avatar.png"
  },
  "message_id": "22",
  "filename": "README.md",
  "filesize": 2232,
  "upload_time": 1384414750
}

Parameters:

• room_id (Integer)
• file_id (Integer)
• create_download_url (Boolean) (defaults to: nil) —

  whether or not to create a download link. If set to true, download like will be created for 30 seconds

Yields:

• (response_body, response_header) —

  if block was given, return response body and response header through block arguments

Yield Parameters:

• response_body (Hashie::Mash) —

  response body

• response_header (Hash<String, String>) —

  response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)

Returns:

• (Hashie::Mash)

See Also:

• http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files-file_id
• http://download.chatwork.com/ChatWork_API_Documentation.pdf

# File 'lib/chatwork/client/file_methods.rb', line 64

def find_file(room_id:, file_id:, create_download_url: nil, &block)
  get("/rooms/#{room_id}/files/#{file_id}", create_download_url: boolean_to_integer(create_download_url), &block)
end