Module: ChatWork::Message

Defined in:
lib/chatwork/message.rb

Class Method Summary collapse

Class Method Details

.create(room_id:, body:, self_unread: false) {|response_body, response_header| ... } ⇒ Hashie::Mash

Add new message to the chat

Examples:

response format

{
  "message_id": "1234"
}

Parameters:

  • room_id (Integer)
  • body (String) —

    message body

  • self_unread (Boolean) (defaults to: false) —

    Whether to add the added message as unread by looking at it from myself

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:



56
57
58
 
# File 'lib/chatwork/message.rb', line 56

def self.create(room_id:, body:, self_unread: false, &block)
  ChatWork.client.create_message(room_id: room_id, body: body, self_unread: self_unread, &block)
end

.destroy(room_id:, message_id:) {|response_body, response_header| ... } ⇒ Hashie::Mash

Destroy the specified message

Examples:

response format

{
  "message_id": "1234"
}

Parameters:

  • room_id (Integer)
  • message_id (String)

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:



177
178
179
 
# File 'lib/chatwork/message.rb', line 177

def self.destroy(room_id:, message_id:, &block)
  ChatWork.client.destroy_message(room_id: room_id, message_id: message_id, &block)
end

.find(room_id:, message_id:) {|response_body, response_header| ... } ⇒ Hashie::Mash

Get information about the specified message

Examples:

response format

{
  "message_id": "5",
  "account": {
    "account_id": 123,
    "name": "Bob",
    "avatar_image_url": "https://example.com/ico_avatar.png"
  },
  "body": "Hello Chatwork!",
  "send_time": 1384242850,
  "update_time": 0
}

Parameters:

  • room_id (Integer)
  • message_id (String)

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:



132
133
134
 
# File 'lib/chatwork/message.rb', line 132

def self.find(room_id:, message_id:, &block)
  ChatWork.client.find_message(room_id: room_id, message_id: message_id, &block)
end

.get(room_id:, force: nil) {|response_body, response_header| ... } ⇒ Array<Hashie::Mash>

Get all messages associated with the specified chat (returns up to 100 entries).

If the parameter is not set, it returns the next 100 entries from previous call.

Examples:

response format

[
  {
    "message_id": "5",
    "account": {
      "account_id": 123,
      "name": "Bob",
      "avatar_image_url": "https://example.com/ico_avatar.png"
    },
    "body": "Hello Chatwork!",
    "send_time": 1384242850,
    "update_time": 0
  }
]

Parameters:

  • room_id (Integer)
  • force (Boolean, Integer) (defaults to: nil) —

    Flag which forces to get 100 newest entries regardless of previous calls.

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:



33
34
35
 
# File 'lib/chatwork/message.rb', line 33

def self.get(room_id:, force: nil, &block)
  ChatWork.client.get_messages(room_id: room_id, force: force, &block)
end

.read(room_id:, message_id: nil) {|response_body, response_header| ... } ⇒ Hashie::Mash

Mark messages as read

Examples:

response format

{
  "unread_num": 461,
  "mention_num": 0
}

Parameters:

  • room_id (Integer)
  • message_id (String) (defaults to: nil)

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:



79
80
81
 
# File 'lib/chatwork/message.rb', line 79

def self.read(room_id:, message_id: nil, &block)
  ChatWork.client.read_message(room_id: room_id, message_id: message_id, &block)
end

.unread(room_id:, message_id:) {|response_body, response_header| ... } ⇒ Hashie::Mash

Mark messages as unread

Examples:

response format

{
  "unread_num": 3,
  "mention_num": 0
}

Parameters:

  • room_id (Integer)
  • message_id (String)

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:



102
103
104
 
# File 'lib/chatwork/message.rb', line 102

def self.unread(room_id:, message_id:, &block)
  ChatWork.client.unread_message(room_id: room_id, message_id: message_id, &block)
end

.update(room_id:, message_id:, body:) {|response_body, response_header| ... } ⇒ Hashie::Mash

Update the specified message

Examples:

response format

{
  "message_id": "1234"
}

Parameters:

  • room_id (Integer)
  • message_id (String)
  • body (String) —

    message body

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:



155
156
157
 
# File 'lib/chatwork/message.rb', line 155

def self.update(room_id:, message_id:, body:, &block)
  ChatWork.client.update_message(room_id: room_id, message_id: message_id, body: body, &block)
end