Class: DocuSign_Rooms::GetRolesOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_rooms/api/roles_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#count ⇒ Object

The number of results to return. This value must be a number between ‘1` and `100` (default).



39
40
41
 
# File 'lib/docusign_rooms/api/roles_api.rb', line 39

def count
  @count
end

#filter ⇒ Object

A search filter that returns roles by the beginning of the role name. You can enter the beginning of the role name only to return all of the roles that begin with the text that you entered.



33
34
35
 
# File 'lib/docusign_rooms/api/roles_api.rb', line 33

def filter
  @filter
end

#filter_context ⇒ Object

Attribute establishing filter context for roles being returned - AllRoles, AssignableRolesBasedOnCompanyPermissions, AssignableRolesBasedOnAllPermissions



30
31
32
 
# File 'lib/docusign_rooms/api/roles_api.rb', line 30

def filter_context
  @filter_context
end

#only_assignable ⇒ Object

Returns assignable roles based on calling user’s company permissions. DEPRECATED: Please use filterContext parameter to get the assignable roles. AssignableRolesBasedOnCompanyPermissions returns same results as onlyAssignable=true



27
28
29
 
# File 'lib/docusign_rooms/api/roles_api.rb', line 27

def only_assignable
  @only_assignable
end

#start_position ⇒ Object

The starting zero-based index position of the result set. The default value is 0.



36
37
38
 
# File 'lib/docusign_rooms/api/roles_api.rb', line 36

def start_position
  @start_position
end

Class Method Details

.default ⇒ Object 



41
42
43
 
# File 'lib/docusign_rooms/api/roles_api.rb', line 41

def self.default
  @@default ||= GetRolesOptions.new
end