Class: GetStream::Generated::Models::SendMessageRequest

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

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 = {}) ⇒ SendMessageRequest

Initialize with attributes



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/getstream_ruby/generated/models/send_message_request.rb', line 41

def initialize(attributes = {})
  super(attributes)
  @message = attributes[:message] || attributes['message']
  @force_moderation = attributes[:force_moderation] || attributes['force_moderation'] || nil
  @include_channel_context = attributes[:include_channel_context] || attributes['include_channel_context'] || nil
  @include_mentioned_members = attributes[:include_mentioned_members] || attributes['include_mentioned_members'] || nil
  @keep_channel_hidden = attributes[:keep_channel_hidden] || attributes['keep_channel_hidden'] || nil
  @pending = attributes[:pending] || attributes['pending'] || nil
  @skip_enrich_url = attributes[:skip_enrich_url] || attributes['skip_enrich_url'] || nil
  @skip_push = attributes[:skip_push] || attributes['skip_push'] || nil
  @pending_message_metadata = attributes[:pending_message_metadata] || attributes['pending_message_metadata'] || nil
end

Instance Attribute Details

#force_moderation ⇒ Boolean

Returns:

  • (Boolean) 


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

def force_moderation
  @force_moderation
end

#include_channel_context ⇒ Boolean

Returns When true, the response includes channel_context: a slim channel object with cid, type, id and created_by.

Returns:

  • (Boolean) —

    When true, the response includes channel_context: a slim channel object with cid, type, id and created_by



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

def include_channel_context
  @include_channel_context
end

#include_mentioned_members ⇒ Boolean

Returns When true, the response includes mentioned_members: for each mentioned user, whether that user is currently a channel member. Requires the ReadChannelMembers permission.

Returns:

  • (Boolean) —

    When true, the response includes mentioned_members: for each mentioned user, whether that user is currently a channel member. Requires the ReadChannelMembers permission



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

def include_mentioned_members
  @include_mentioned_members
end

#keep_channel_hidden ⇒ Boolean

Returns:

  • (Boolean) 


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

def keep_channel_hidden
  @keep_channel_hidden
end

#message ⇒ MessageRequest

Returns Message data for creating or updating a message.

Returns:

  • (MessageRequest) —

    Message data for creating or updating a message



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

def message
  @message
end

#pending ⇒ Boolean

Returns:

  • (Boolean) 


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

def pending
  @pending
end

#pending_message_metadata ⇒ Hash<String, String>

Returns:

  • (Hash<String, String>) 


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

def pending_message_metadata
  @pending_message_metadata
end

#skip_enrich_url ⇒ Boolean

Returns:

  • (Boolean) 


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

def skip_enrich_url
  @skip_enrich_url
end

#skip_push ⇒ Boolean

Returns:

  • (Boolean) 


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

def skip_push
  @skip_push
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



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

def self.json_field_mappings
  {
    message: 'message',
    force_moderation: 'force_moderation',
    include_channel_context: 'include_channel_context',
    include_mentioned_members: 'include_mentioned_members',
    keep_channel_hidden: 'keep_channel_hidden',
    pending: 'pending',
    skip_enrich_url: 'skip_enrich_url',
    skip_push: 'skip_push',
    pending_message_metadata: 'pending_message_metadata'
  }
end