Class: GetStream::Generated::Models::CreatePollRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/create_poll_request.rb

Overview

Contains all information needed to create a new poll

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ CreatePollRequest

Initialize with attributes



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 53

def initialize(attributes = {})
  super(attributes)
  @name = attributes[:name] || attributes['name']
  @allow_answers = attributes[:allow_answers] || attributes['allow_answers'] || nil
  @allow_user_suggested_options = attributes[:allow_user_suggested_options] || attributes['allow_user_suggested_options'] || nil
  @description = attributes[:description] || attributes['description'] || nil
  @enforce_unique_vote = attributes[:enforce_unique_vote] || attributes['enforce_unique_vote'] || nil
  @id = attributes[:id] || attributes['id'] || nil
  @is_closed = attributes[:is_closed] || attributes['is_closed'] || nil
  @max_votes_allowed = attributes[:max_votes_allowed] || attributes['max_votes_allowed'] || nil
  @user_id = attributes[:user_id] || attributes['user_id'] || nil
  @voting_visibility = attributes[:voting_visibility] || attributes['voting_visibility'] || nil
  @options = attributes[:options] || attributes['options'] || nil
  @Custom = attributes[:Custom] || attributes['Custom'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#allow_answers ⇒ Boolean

Returns Indicates whether users can suggest user defined answers.

Returns:

  • (Boolean) —

    Indicates whether users can suggest user defined answers



17
18
19
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 17

def allow_answers
  @allow_answers
end

#allow_user_suggested_options ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 20

def allow_user_suggested_options
  @allow_user_suggested_options
end

#Custom ⇒ Object

Returns:

  • (Object) 


47
48
49
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 47

def Custom
  @Custom
end

#description ⇒ String

Returns A description of the poll.

Returns:

  • (String) —

    A description of the poll



23
24
25
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 23

def description
  @description
end

#enforce_unique_vote ⇒ Boolean

Returns Indicates whether users can cast multiple votes.

Returns:

  • (Boolean) —

    Indicates whether users can cast multiple votes



26
27
28
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 26

def enforce_unique_vote
  @enforce_unique_vote
end

#id ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 29

def id
  @id
end

#is_closed ⇒ Boolean

Returns Indicates whether the poll is open for voting.

Returns:

  • (Boolean) —

    Indicates whether the poll is open for voting



32
33
34
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 32

def is_closed
  @is_closed
end

#max_votes_allowed ⇒ Integer

Returns Indicates the maximum amount of votes a user can cast.

Returns:

  • (Integer) —

    Indicates the maximum amount of votes a user can cast



35
36
37
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 35

def max_votes_allowed
  @max_votes_allowed
end

#name ⇒ String

Returns The name of the poll.

Returns:

  • (String) —

    The name of the poll



14
15
16
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 14

def name
  @name
end

#options ⇒ Array<PollOptionInput>

Returns:



44
45
46
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 44

def options
  @options
end

#user ⇒ UserRequest

Returns:



50
51
52
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 50

def user
  @user
end

#user_id ⇒ String

Returns:

  • (String) 


38
39
40
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 38

def user_id
  @user_id
end

#voting_visibility ⇒ String

Returns:

  • (String) 


41
42
43
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 41

def voting_visibility
  @voting_visibility
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/getstream_ruby/generated/models/create_poll_request.rb', line 71

def self.json_field_mappings
  {
    name: 'name',
    allow_answers: 'allow_answers',
    allow_user_suggested_options: 'allow_user_suggested_options',
    description: 'description',
    enforce_unique_vote: 'enforce_unique_vote',
    id: 'id',
    is_closed: 'is_closed',
    max_votes_allowed: 'max_votes_allowed',
    user_id: 'user_id',
    voting_visibility: 'voting_visibility',
    options: 'options',
    Custom: 'Custom',
    user: 'user'
  }
end