Class: Daily::Permissions

Inherits:
Object
  • Object
show all
Defined in:
lib/daily-ruby/models/permissions.rb

Overview

Specifies the initial default permissions for a non-(/guides/configurations-and-settings/controlling-who-joins-a-meeting#meeting-owner-privileges) participant joining a call. Each permission (i.e. each of the properties listed below) can be configured in the meeting token, the room, and/or the domain, in decreasing order of precedence. Participant admins (those with the ‘’participants’‘ value in their `canAdmin` permission) can also change participants’ permissions on the fly during a call using [‘updateParticipant()`](/reference/daily-js/instance-methods/update-participant#permissions) or [`updateParticipants()`](/reference/daily-js/instance-methods/update-participants).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Permissions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/daily-ruby/models/permissions.rb', line 57

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::Permissions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Daily::Permissions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'has_presence')
    self.has_presence = attributes[:'has_presence']
  end

  if attributes.key?(:'can_send')
    self.can_send = attributes[:'can_send']
  end

  if attributes.key?(:'can_admin')
    self.can_admin = attributes[:'can_admin']
  end
end

Instance Attribute Details

#can_adminObject

Returns the value of attribute can_admin.



24
25
26
# File 'lib/daily-ruby/models/permissions.rb', line 24

def can_admin
  @can_admin
end

#can_sendObject

Returns the value of attribute can_send.



22
23
24
# File 'lib/daily-ruby/models/permissions.rb', line 22

def can_send
  @can_send
end

#has_presenceObject

Whether the participant appears as "present" in the call, i.e. whether they appear in [‘participants()`](/reference/daily-js/instance-methods/participants#main).



20
21
22
# File 'lib/daily-ruby/models/permissions.rb', line 20

def has_presence
  @has_presence
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/daily-ruby/models/permissions.rb', line 147

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Daily.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



36
37
38
# File 'lib/daily-ruby/models/permissions.rb', line 36

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



27
28
29
30
31
32
33
# File 'lib/daily-ruby/models/permissions.rb', line 27

def self.attribute_map
  {
    :'has_presence' => :'hasPresence',
    :'can_send' => :'canSend',
    :'can_admin' => :'canAdmin'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/daily-ruby/models/permissions.rb', line 123

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



50
51
52
53
# File 'lib/daily-ruby/models/permissions.rb', line 50

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



41
42
43
44
45
46
47
# File 'lib/daily-ruby/models/permissions.rb', line 41

def self.openapi_types
  {
    :'has_presence' => :'Boolean',
    :'can_send' => :'PermissionsCanSend',
    :'can_admin' => :'PermissionsCanAdmin'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



100
101
102
103
104
105
106
# File 'lib/daily-ruby/models/permissions.rb', line 100

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      has_presence == o.has_presence &&
      can_send == o.can_send &&
      can_admin == o.can_admin
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/daily-ruby/models/permissions.rb', line 218

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


110
111
112
# File 'lib/daily-ruby/models/permissions.rb', line 110

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



116
117
118
# File 'lib/daily-ruby/models/permissions.rb', line 116

def hash
  [has_presence, can_send, can_admin].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



85
86
87
88
89
# File 'lib/daily-ruby/models/permissions.rb', line 85

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



194
195
196
# File 'lib/daily-ruby/models/permissions.rb', line 194

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/daily-ruby/models/permissions.rb', line 200

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



188
189
190
# File 'lib/daily-ruby/models/permissions.rb', line 188

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



93
94
95
96
# File 'lib/daily-ruby/models/permissions.rb', line 93

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end