Class: ChimeSdk::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/chime_sdk/config.rb

Overview

Class used to initialize configuration object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Initialize configuration for ChimeSdk. These configuration can be overridden in initializer.



70
71
72
73
74
75
76
77
78
 
# File 'lib/chime_sdk/config.rb', line 70

def initialize
  @application_name              = 'chime-sdk-rails'
  @media_region                  = 'us-east-1'
  @prefix                        = "#{@application_name}-#{Rails.env}-"
  @max_attendee_results          = 10
  @create_meeting_with_attendee  = true
  @create_attendee_from_meeting  = true
  @create_meeting_by_get_request = false
end

Instance Attribute Details

#application_name ⇒ Boolean #application_name=(value) ⇒ Boolean

Overloads:

  • #application_name ⇒ Boolean

    Return application name for unique key and metadata of Chime SDK meetings and attendees.

    Returns:

    • (Boolean) —

      application name for unique key and metadata of Chime SDK meetings and attendees

  • #application_name=(value) ⇒ Boolean

    Set application name for unique key and metadata of Chime SDK meetings and attendees.

    Parameters:

    • application_name (Boolean) —

      The new application_name

    Returns:

    • (Boolean) —

      application name for unique key and metadata of Chime SDK meetings and attendees



11
12
13
 
# File 'lib/chime_sdk/config.rb', line 11

def application_name
  @application_name
end

#create_attendee_from_meeting ⇒ Boolean #create_attendee_from_meeting=(value) ⇒ Boolean

Overloads:

  • #create_attendee_from_meeting ⇒ Boolean

    Return whether the application creates attendee from meeting in meetings#show action.

    Returns:

    • (Boolean) —

      Whether the application creates attendee from meeting in meetings#show action

  • #create_attendee_from_meeting=(value) ⇒ Boolean

    Set whether the application creates attendee from meeting in meetings#show action.

    Parameters:

    • create_attendee_from_meeting (Boolean) —

      The new create_attendee_from_meeting

    Returns:

    • (Boolean) —

      Whether the application creates attendee from meeting in meetings#show action



56
57
58
 
# File 'lib/chime_sdk/config.rb', line 56

def create_attendee_from_meeting
  @create_attendee_from_meeting
end

#create_meeting_by_get_request ⇒ Boolean #create_meeting_by_get_request=(value) ⇒ Boolean

Overloads:

  • #create_meeting_by_get_request ⇒ Boolean

    Return whether the application creates meeting in meetings#index action by HTTP GET request.

    Returns:

    • (Boolean) —

      Whether the application creates meeting in meetings#index action by HTTP GET request

  • #create_meeting_by_get_request=(value) ⇒ Boolean

    Set whether the application creates meeting in meetings#index action by HTTP GET request.

    Parameters:

    • create_meeting_by_get_request (Boolean) —

      The new create_meeting_by_get_request

    Returns:

    • (Boolean) —

      Whether the application creates meeting in meetings#index action by HTTP GET request



65
66
67
 
# File 'lib/chime_sdk/config.rb', line 65

def create_meeting_by_get_request
  @create_meeting_by_get_request
end

#create_meeting_with_attendee ⇒ Boolean #create_meeting_with_attendee=(value) ⇒ Boolean

Overloads:

  • #create_meeting_with_attendee ⇒ Boolean

    Return whether the application creates meeting with attendee in meetings#create action.

    Returns:

    • (Boolean) —

      Whether the application creates meeting with attendee in meetings#create action

  • #create_meeting_with_attendee=(value) ⇒ Boolean

    Set whether the application creates meeting with attendee in meetings#create action.

    Parameters:

    • create_meeting_with_attendee (Boolean) —

      The new create_meeting_with_attendee

    Returns:

    • (Boolean) —

      Whether the application creates meeting with attendee in meetings#create action



47
48
49
 
# File 'lib/chime_sdk/config.rb', line 47

def create_meeting_with_attendee
  @create_meeting_with_attendee
end

#max_attendee_results ⇒ Boolean #max_attendee_results=(value) ⇒ Boolean

Overloads:

  • #max_attendee_results ⇒ Boolean

    Return default max_results value used in list_attendees API.

    Returns:

    • (Boolean) —

      Default max_results value used in list_attendees API

  • #max_attendee_results=(value) ⇒ Boolean

    Set default max_results value used in list_attendees API.

    Parameters:

    • max_attendee_results (Boolean) —

      The new max_attendee_results

    Returns:

    • (Boolean) —

      Default max_results value used in list_attendees API



38
39
40
 
# File 'lib/chime_sdk/config.rb', line 38

def max_attendee_results
  @max_attendee_results
end

#media_region ⇒ Boolean #media_region=(value) ⇒ Boolean

Overloads:

  • #media_region ⇒ Boolean

    Return media region to host Chime SDK meetings.

    Returns:

    • (Boolean) —

      Media region to host Chime SDK meetings

  • #media_region=(value) ⇒ Boolean

    Set media region to host Chime SDK meetings.

    Parameters:

    • media_region (Boolean) —

      The new media_region

    Returns:

    • (Boolean) —

      Media region to host Chime SDK meetings



20
21
22
 
# File 'lib/chime_sdk/config.rb', line 20

def media_region
  @media_region
end

#prefix ⇒ Boolean #prefix=(value) ⇒ Boolean

Overloads:

  • #prefix ⇒ Boolean

    Return prefix to make unique key of Chime SDK meetings and attendees.

    Returns:

    • (Boolean) —

      Prefix to make unique key of Chime SDK meetings and attendees

  • #prefix=(value) ⇒ Boolean

    Set prefix to make unique key of Chime SDK meetings and attendees.

    Parameters:

    • prefix (Boolean) —

      The new prefix

    Returns:

    • (Boolean) —

      Prefix to make unique key of Chime SDK meetings and attendees



29
30
31
 
# File 'lib/chime_sdk/config.rb', line 29

def prefix
  @prefix
end