Module: ChatWork::Member

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

Class Method Summary collapse

Class Method Details

.get(room_id:) ⇒ Array<Hashie::Mash>

Get the list of all chat members associated with the specified chat

Examples:

response format

[
  {
    "account_id": 123,
    "role": "member",
    "name": "John Smith",
    "chatwork_id": "tarochatworkid",
    "organization_id": 101,
    "organization_name": "Hello Company",
    "department": "Marketing",
    "avatar_image_url": "https://example.com/abc.png"
  }
]

Parameters:

  • room_id (Integer)

Returns:

  • (Array<Hashie::Mash>)

See Also:



27
28
29
 
# File 'lib/chatwork/member.rb', line 27

def self.get(room_id:)
  _get("/rooms/#{room_id}/members")
end

.update_all(room_id:, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil) ⇒ Hashie::Mash

Change associated members of group chat at once

Examples:

response format

{
  "admin": [123, 542, 1001],
  "member": [10, 103],
  "readonly": [6, 11]
}

Parameters:

  • room_id (Integer)
  • members_admin_ids (Array<Integer>, String) —

    List of user IDs who will be given administrator permission for the group chat. At least one user must be specified as an administrator.

  • members_member_ids (Array<Integer>, String) (defaults to: nil) —

    List of user IDs who will be given member permission for the group chat.

  • members_readonly_ids (Array<Integer>, String) (defaults to: nil) —

    List of user IDs who will be given read-only permission for the group chat.

Returns:

  • (Hashie::Mash)

See Also:



50
51
52
53
54
55
56
57
58
 
# File 'lib/chatwork/member.rb', line 50

def self.update_all(room_id:, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil)
  params = {
    members_admin_ids: Array(members_admin_ids).join(","),
  }
  params[:members_member_ids] = Array(members_member_ids).join(",") if members_member_ids
  params[:members_readonly_ids] = Array(members_readonly_ids).join(",") if members_readonly_ids

  _put("/rooms/#{room_id}/members", params)
end