Class: MicrosoftGraph::Models::LearningProvider

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/learning_provider.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new learningProvider and sets the default values.



40
41
42
 
# File 'lib/models/learning_provider.rb', line 40

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a learning_provider

Raises:

  • (StandardError) 


48
49
50
51
 
# File 'lib/models/learning_provider.rb', line 48

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return LearningProvider.new
end

Instance Method Details

#display_name ⇒ Object

Gets the displayName property value. The display name that appears in Viva Learning. Required.

Returns:

  • a string



56
57
58
 
# File 'lib/models/learning_provider.rb', line 56

def display_name
    return @display_name
end

#display_name=(value) ⇒ Object

Sets the displayName property value. The display name that appears in Viva Learning. Required.

Parameters:

  • value —

    Value to set for the displayName property.

Returns:

  • a void



64
65
66
 
# File 'lib/models/learning_provider.rb', line 64

def display_name=(value)
    @display_name = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/models/learning_provider.rb', line 71

def get_field_deserializers()
    return super.merge({
        "displayName" => lambda {|n| @display_name = n.get_string_value() },
        "isCourseActivitySyncEnabled" => lambda {|n| @is_course_activity_sync_enabled = n.get_boolean_value() },
        "learningContents" => lambda {|n| @learning_contents = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::LearningContent.create_from_discriminator_value(pn) }) },
        "learningCourseActivities" => lambda {|n| @learning_course_activities = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::LearningCourseActivity.create_from_discriminator_value(pn) }) },
        "loginWebUrl" => lambda {|n| @login_web_url = n.get_string_value() },
        "longLogoWebUrlForDarkTheme" => lambda {|n| @long_logo_web_url_for_dark_theme = n.get_string_value() },
        "longLogoWebUrlForLightTheme" => lambda {|n| @long_logo_web_url_for_light_theme = n.get_string_value() },
        "squareLogoWebUrlForDarkTheme" => lambda {|n| @square_logo_web_url_for_dark_theme = n.get_string_value() },
        "squareLogoWebUrlForLightTheme" => lambda {|n| @square_logo_web_url_for_light_theme = n.get_string_value() },
    })
end

#is_course_activity_sync_enabled ⇒ Object

Gets the isCourseActivitySyncEnabled property value. Indicates whether a provider can ingest learning course activity records. The default value is false. Set to true to make learningCourseActivities available for this provider.

Returns:

  • a boolean



88
89
90
 
# File 'lib/models/learning_provider.rb', line 88

def is_course_activity_sync_enabled
    return @is_course_activity_sync_enabled
end

#is_course_activity_sync_enabled=(value) ⇒ Object

Sets the isCourseActivitySyncEnabled property value. Indicates whether a provider can ingest learning course activity records. The default value is false. Set to true to make learningCourseActivities available for this provider.

Parameters:

  • value —

    Value to set for the isCourseActivitySyncEnabled property.

Returns:

  • a void



96
97
98
 
# File 'lib/models/learning_provider.rb', line 96

def is_course_activity_sync_enabled=(value)
    @is_course_activity_sync_enabled = value
end

#learning_contents ⇒ Object

Gets the learningContents property value. Learning catalog items for the provider.

Returns:

  • a learning_content



103
104
105
 
# File 'lib/models/learning_provider.rb', line 103

def learning_contents
    return @learning_contents
end

#learning_contents=(value) ⇒ Object

Sets the learningContents property value. Learning catalog items for the provider.

Parameters:

  • value —

    Value to set for the learningContents property.

Returns:

  • a void



111
112
113
 
# File 'lib/models/learning_provider.rb', line 111

def learning_contents=(value)
    @learning_contents = value
end

#learning_course_activities ⇒ Object

Gets the learningCourseActivities property value. The learningCourseActivities property

Returns:

  • a learning_course_activity



118
119
120
 
# File 'lib/models/learning_provider.rb', line 118

def learning_course_activities
    return @learning_course_activities
end

#learning_course_activities=(value) ⇒ Object

Sets the learningCourseActivities property value. The learningCourseActivities property

Parameters:

  • value —

    Value to set for the learningCourseActivities property.

Returns:

  • a void



126
127
128
 
# File 'lib/models/learning_provider.rb', line 126

def learning_course_activities=(value)
    @learning_course_activities = value
end

#login_web_url ⇒ Object

Gets the loginWebUrl property value. Authentication URL to access the courses for the provider. Optional.

Returns:

  • a string



133
134
135
 
# File 'lib/models/learning_provider.rb', line 133

def 
    return @login_web_url
end

#login_web_url=(value) ⇒ Object

Sets the loginWebUrl property value. Authentication URL to access the courses for the provider. Optional.

Parameters:

  • value —

    Value to set for the loginWebUrl property.

Returns:

  • a void



141
142
143
 
# File 'lib/models/learning_provider.rb', line 141

def (value)
    @login_web_url = value
end

#long_logo_web_url_for_dark_theme ⇒ Object

Gets the longLogoWebUrlForDarkTheme property value. The long logo URL for the dark mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Returns:

  • a string



148
149
150
 
# File 'lib/models/learning_provider.rb', line 148

def long_logo_web_url_for_dark_theme
    return @long_logo_web_url_for_dark_theme
end

#long_logo_web_url_for_dark_theme=(value) ⇒ Object

Sets the longLogoWebUrlForDarkTheme property value. The long logo URL for the dark mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Parameters:

  • value —

    Value to set for the longLogoWebUrlForDarkTheme property.

Returns:

  • a void



156
157
158
 
# File 'lib/models/learning_provider.rb', line 156

def long_logo_web_url_for_dark_theme=(value)
    @long_logo_web_url_for_dark_theme = value
end

#long_logo_web_url_for_light_theme ⇒ Object

Gets the longLogoWebUrlForLightTheme property value. The long logo URL for the light mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Returns:

  • a string



163
164
165
 
# File 'lib/models/learning_provider.rb', line 163

def long_logo_web_url_for_light_theme
    return @long_logo_web_url_for_light_theme
end

#long_logo_web_url_for_light_theme=(value) ⇒ Object

Sets the longLogoWebUrlForLightTheme property value. The long logo URL for the light mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Parameters:

  • value —

    Value to set for the longLogoWebUrlForLightTheme property.

Returns:

  • a void



171
172
173
 
# File 'lib/models/learning_provider.rb', line 171

def long_logo_web_url_for_light_theme=(value)
    @long_logo_web_url_for_light_theme = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/models/learning_provider.rb', line 179

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_string_value("displayName", @display_name)
    writer.write_boolean_value("isCourseActivitySyncEnabled", @is_course_activity_sync_enabled)
    writer.write_collection_of_object_values("learningContents", @learning_contents)
    writer.write_collection_of_object_values("learningCourseActivities", @learning_course_activities)
    writer.write_string_value("loginWebUrl", @login_web_url)
    writer.write_string_value("longLogoWebUrlForDarkTheme", @long_logo_web_url_for_dark_theme)
    writer.write_string_value("longLogoWebUrlForLightTheme", @long_logo_web_url_for_light_theme)
    writer.write_string_value("squareLogoWebUrlForDarkTheme", @square_logo_web_url_for_dark_theme)
    writer.write_string_value("squareLogoWebUrlForLightTheme", @square_logo_web_url_for_light_theme)
end

#square_logo_web_url_for_dark_theme ⇒ Object

Gets the squareLogoWebUrlForDarkTheme property value. The square logo URL for the dark mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Returns:

  • a string



196
197
198
 
# File 'lib/models/learning_provider.rb', line 196

def square_logo_web_url_for_dark_theme
    return @square_logo_web_url_for_dark_theme
end

#square_logo_web_url_for_dark_theme=(value) ⇒ Object

Sets the squareLogoWebUrlForDarkTheme property value. The square logo URL for the dark mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Parameters:

  • value —

    Value to set for the squareLogoWebUrlForDarkTheme property.

Returns:

  • a void



204
205
206
 
# File 'lib/models/learning_provider.rb', line 204

def square_logo_web_url_for_dark_theme=(value)
    @square_logo_web_url_for_dark_theme = value
end

#square_logo_web_url_for_light_theme ⇒ Object

Gets the squareLogoWebUrlForLightTheme property value. The square logo URL for the light mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Returns:

  • a string



211
212
213
 
# File 'lib/models/learning_provider.rb', line 211

def square_logo_web_url_for_light_theme
    return @square_logo_web_url_for_light_theme
end

#square_logo_web_url_for_light_theme=(value) ⇒ Object

Sets the squareLogoWebUrlForLightTheme property value. The square logo URL for the light mode that needs to be a publicly accessible image. This image would be saved to the blob storage of Viva Learning for rendering within the Viva Learning app. Required.

Parameters:

  • value —

    Value to set for the squareLogoWebUrlForLightTheme property.

Returns:

  • a void



219
220
221
 
# File 'lib/models/learning_provider.rb', line 219

def square_logo_web_url_for_light_theme=(value)
    @square_logo_web_url_for_light_theme = value
end