Class: OpenfireApiRuby::GroupService

Inherits:
Object
  • Object
show all
Defined in:
lib/openfire_api_ruby/group_service.rb

Defined Under Namespace

Classes: GroupAlreadyExistsException, GroupNotFoundException, GroupServiceDisabledException, HTTPException, IllegalArgumentException, InvalidResponseException, RequestNotAuthorisedException

Constant Summary collapse

@@api_path = 
"plugins/groupService/groupservice"
@@api_exceptions = 
%w(GroupServiceDisabled RequestNotAuthorised IllegalArgumentException GroupNotFoundException GroupAlreadyExistsException)

Instance Method Summary collapse

Constructor Details

#initialize(options = Hash.new) ⇒ GroupService

Returns a new instance of GroupService.



14
15
16
 
# File 'lib/openfire_api_ruby/group_service.rb', line 14

def initialize(options=Hash.new)
  @options = { :path => @@api_path }.merge(options)
end

Instance Method Details

#add_group!(opts) ⇒ Object 



18
19
20
 
# File 'lib/openfire_api_ruby/group_service.rb', line 18

def add_group!(opts)
  submit_request(opts.merge(:type => :add))
end

#delete_group!(opts) ⇒ Object 



22
23
24
 
# File 'lib/openfire_api_ruby/group_service.rb', line 22

def delete_group!(opts)
  submit_request(opts.merge(:type => :delete))
end

#lock_group!(opts) ⇒ Object 



30
31
32
 
# File 'lib/openfire_api_ruby/group_service.rb', line 30

def lock_group!(opts)
  submit_request(opts.merge(:type => :disable))
end

#unlock_group!(opts) ⇒ Object 



34
35
36
 
# File 'lib/openfire_api_ruby/group_service.rb', line 34

def unlock_group!(opts)
  submit_request(opts.merge(:type => :enable))
end

#update_group!(opts) ⇒ Object 



26
27
28
 
# File 'lib/openfire_api_ruby/group_service.rb', line 26

def update_group!(opts)
  submit_request(opts.merge(:type => :update))
end