Module: ChatWork::InvitationLink

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

Class Method Summary collapse

Class Method Details

.create(room_id:, code: nil, description: nil, need_acceptance: nil) ⇒ Hashie::Mash

Create invitation link

Examples:

response format

{
  "public": true,
  "url": "https://example.chatwork.com/g/unique-link-name",
  "need_acceptance": true,
  "description": "This is a public room for topic A."
}

See Also:



44
45
46
47
48
49
50
51
 
# File 'lib/chatwork/invitation_link.rb', line 44

def self.create(room_id:, code: nil, description: nil, need_acceptance: nil)
  params = {
    code:            code,
    description:     description,
    need_acceptance: boolean_to_integer(need_acceptance),
  }
  _post("/rooms/#{room_id}/link", params)
end

.destroy(room_id:) ⇒ Hashie::Mash

Delete invitation link

Examples:

response format

{
  "public": false
}

See Also:



94
95
96
 
# File 'lib/chatwork/invitation_link.rb', line 94

def self.destroy(room_id:)
  _delete("/rooms/#{room_id}/link")
end

.get(room_id:) ⇒ Hashie::Mash

Get invitation link

Examples:

response format

{
  "public": true,
  "url": "https://example.chatwork.com/g/randomcode42",
  "need_acceptance": true,
  "description": "Link description text"
}

See Also:



21
22
23
 
# File 'lib/chatwork/invitation_link.rb', line 21

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

.update(room_id:, code: nil, description: nil, need_acceptance: nil) ⇒ 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"
}

See Also:



72
73
74
75
76
77
78
79
 
# File 'lib/chatwork/invitation_link.rb', line 72

def self.update(room_id:, code: nil, description: nil, need_acceptance: nil)
  params = {
    code:            code,
    description:     description,
    need_acceptance: boolean_to_integer(need_acceptance),
  }
  _put("/rooms/#{room_id}/link", params)
end