Module: ChatWork::Task

Extended by:
EntityMethods
Defined in:
lib/chatwork/task.rb

Class Method Summary collapse

Class Method Details

.create(room_id:, body:, to_ids:, limit: nil) ⇒ Hashie::Mash

Add a new task to the chat

Examples:

response format

{
  "task_ids": [123,124]
}

Parameters:

  • room_id (Integer)
  • body (String) —

    Task description

  • to_ids (Array<Integer>, String) —

    Account ID of the person/people responsible to complete the task

  • limit (Time, Integer) (defaults to: nil) —

    When the task is due

Returns:

  • (Hashie::Mash)

See Also:



59
60
61
62
63
64
65
66
67
 
# File 'lib/chatwork/task.rb', line 59

def self.create(room_id:, body:, to_ids:, limit: nil)
  params = {
    body:   body,
    to_ids: Array(to_ids).join(","),
  }
  params[:limit] = limit.to_i if limit

  _post("/rooms/#{room_id}/tasks", params)
end

.find(room_id:, task_id:) ⇒ Hashie::Mash

Get information about the specified task

Examples:

response format

{
  "task_id": 3,
  "account": {
    "account_id": 123,
    "name": "Bob",
    "avatar_image_url": "https://example.com/abc.png"
  },
  "assigned_by_account": {
    "account_id": 456,
    "name": "Anna",
    "avatar_image_url": "https://example.com/def.png"
  },
  "message_id": "13",
  "body": "buy milk",
  "limit_time": 1384354799,
  "status": "open"
}

Parameters:

  • room_id (Integer)
  • task_id (Integer)

Returns:

  • (Hashie::Mash)

See Also:



97
98
99
 
# File 'lib/chatwork/task.rb', line 97

def self.find(room_id:, task_id:)
  _get("/rooms/#{room_id}/tasks/#{task_id}")
end

.get(room_id:, account_id:, assigned_by_account_id: nil, status: nil) ⇒ Array<Hashie::Mash>

Get the list of tasks associated with the specified chat

(*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)

Examples:

response format

[
  {
    "task_id": 3,
    "account": {
      "account_id": 123,
      "name": "Bob",
      "avatar_image_url": "https://example.com/abc.png"
    },
    "assigned_by_account": {
      "account_id": 456,
      "name": "Anna",
      "avatar_image_url": "https://example.com/def.png"
    },
    "message_id": "13",
    "body": "buy milk",
    "limit_time": 1384354799,
    "status": "open"
  }
]

Parameters:

  • room_id (Integer)
  • account_id (Integer)
  • assigned_by_account_id (Integer) (defaults to: nil) —

    Account ID of the person who assigned task

  • status (String) (defaults to: nil) —

    Task status (open, done)

Returns:

  • (Array<Hashie::Mash>)

See Also:



39
40
41
 
# File 'lib/chatwork/task.rb', line 39

def self.get(room_id:, account_id:, assigned_by_account_id: nil, status: nil)
  _get("/rooms/#{room_id}/tasks", account_id: , assigned_by_account_id: , status: status)
end