Method: ChatWork::Client::RoomMethods#get_rooms

Defined in:

lib/chatwork/client/room_methods.rb

#get_rooms {|response_body, response_header| ... } ⇒ Array<Hashie::Mash>

Get the list of all chats on your account

Examples:

response format

[
  {
    "room_id": 123,
    "name": "Group Chat Name",
    "type": "group",
    "role": "admin",
    "sticky": false,
    "unread_num": 10,
    "mention_num": 1,
    "mytask_num": 0,
    "message_num": 122,
    "file_num": 10,
    "task_num": 17,
    "icon_path": "https://example.com/ico_group.png",
    "last_update_time": 1298905200
  }
]

Yields:

• (response_body, response_header) —

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

Yield Parameters:

• response_body (Array<Hashie::Mash>) —

  response body

• response_header (Hash<String, String>) —

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

Returns:

• (Array<Hashie::Mash>)

See Also:

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

# File 'lib/chatwork/client/room_methods.rb', line 31

def get_rooms(&block)
  get("/rooms", &block)
end