Method: ChatWork::InvitationLink.update

Defined in:

lib/chatwork/invitation_link.rb

.update(room_id:, code: nil, description: nil, need_acceptance: nil) {|response_body, response_header| ... } ⇒ Hashie::Mash

Update invitation link

Examples:

response format

{
  "public": true,
  "url": "https://example.chatwork.com/g/another_link_name",
  "need_acceptance": false,
  "description": "Public room for everybody"
}

Parameters:

• room_id (Integer)
• code (String) (defaults to: nil) —

  link path (default. random string)

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

  description of link page

• need_acceptance (Boolean) (defaults to: nil) —

  Approval necessity. Whether participation requires administrator approval.

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#PUT-rooms-room_id-link
• http://download.chatwork.com/ChatWork_API_Documentation.pdf

# File 'lib/chatwork/invitation_link.rb', line 77

def self.update(room_id:, code: nil, description: nil, need_acceptance: nil, &block)
  ChatWork.client.update_invitation_link(room_id: room_id, code: code, description: description, need_acceptance: need_acceptance, &block)
end