Class: Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization

Inherits:

T::Struct

• Object
• T::Struct
• Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization

Extended by:

T::Sig

Defined in:

lib/onlyoffice/docs_integration_sdk/document_editor/config.rb

Overview

Since:

• 0.1.0

Defined Under Namespace

Classes: Anonymous, Close, Customer, Features, Feedback, Font, GoBack, IntegrationMode, Layout, Logo, MacrosMode, Mobile, PointerMode, Review, SubmitForm, UiTheme, Unit

Instance Attribute Summary

• #about ⇒ Boolean^?
• #anonymous ⇒ Anonymous^?
• #autosave ⇒ Boolean^?
• #chat ⇒ Boolean^? deprecated Deprecated.

  Use Document::Permissions#chat instead. This property is deprecated since Document Server version 7.1.

• #close ⇒ Close^?
• #comment_author_only ⇒ Boolean^? deprecated Deprecated.

  Use Document::Permissions#edit_comment_author_only and Document::Permissions#delete_comment_author_only instead. This property is deprecated since Document Server version 6.3.

• #comments ⇒ Boolean^?
• #compact_header ⇒ Boolean^?
• #compact_toolbar ⇒ Boolean^?
• #compatible_features ⇒ Boolean^?
• #customer ⇒ Customer^?
• #features ⇒ Features^?
• #feedback ⇒ Feedback, ...
• #font ⇒ Font^?
• #forcesave ⇒ Boolean^?
• #goback ⇒ GoBack^?
• #help ⇒ Boolean^?
• #hide_notes ⇒ Boolean^?
• #hide_right_menu ⇒ Boolean^?
• #hide_rulers ⇒ Boolean^?
• #integration_mode ⇒ IntegrationMode^?
• #layout ⇒ Layout^?
• #left_menu ⇒ Boolean^? deprecated Deprecated.

  Use Layout#left_menu instead. This property is deprecated since Document Server version 7.1.

• #loader_logo ⇒ String^?
• #loader_name ⇒ String^?
• #logo ⇒ Logo^?
• #macros ⇒ Boolean^?
• #macros_mode ⇒ MacrosMode^?
• #mention_share ⇒ Boolean^?
• #mobile ⇒ Mobile^?
• #mobile_force_view ⇒ Boolean^? deprecated Deprecated.

  Use #mobile instead. This property is deprecated since Document Server version 8.2.

• #plugins ⇒ Boolean^?
• #pointer_mode ⇒ PointerMode^?
• #review ⇒ Review^?
• #review_display ⇒ Review::ReviewDisplay^? deprecated Deprecated.

  Use Review#review_display instead. This property is deprecated since Document Server version 7.0.

• #right_menu ⇒ Boolean^? deprecated Deprecated.

  Use Layout#right_menu instead. This property is deprecated since Document Server version 7.1.

• #show_review_changes ⇒ Boolean^? deprecated Deprecated.

  Use Review#show_review_changes instead. This property is deprecated since Document Server version 7.0.

• #slide_player_background ⇒ String^?
• #spellcheck ⇒ Boolean^? deprecated Deprecated.

  Use Features#spellcheck instead. This property is deprecated since Document Server version 7.1.

• #status_bar ⇒ Boolean^? deprecated Deprecated.

  Use Layout#status_bar instead. This property is deprecated since Document Server version 7.1.

• #submit_form ⇒ SubmitForm, ...
• #toolbar ⇒ Boolean^? deprecated Deprecated.

  Use Layout#toolbar instead. This property is deprecated since Document Server version 7.1.

• #toolbar_hide_file_name ⇒ Boolean^?
• #toolbar_no_tabs ⇒ Boolean^? deprecated Deprecated.

  Use Features#tab_style and Features#tab_background instead. This property is deprecated since Document Server version 8.2.

• #track_changes ⇒ Boolean^? deprecated Deprecated.

  Use Review#track_changes instead. This property is deprecated since Document Server version 7.0.

• #ui_theme ⇒ UiTheme^?
• #unit ⇒ Unit^?
• #word_headings_color ⇒ String^?
• #zoom ⇒ Integer^?

Class Method Summary

• .from_hash(hash, strict = nil) ⇒ Customization

Instance Method Summary

• #initialize(about: nil, anonymous: nil, autosave: nil, chat: nil, close: nil, comment_author_only: nil, comments: nil, compact_header: nil, compact_toolbar: nil, compatible_features: nil, customer: nil, features: nil, feedback: nil, font: nil, forcesave: nil, goback: nil, help: nil, hide_notes: nil, hide_right_menu: nil, hide_rulers: nil, integration_mode: nil, layout: nil, left_menu: nil, loader_logo: nil, loader_name: nil, logo: nil, macros: nil, macros_mode: nil, mention_share: nil, mobile: nil, mobile_force_view: nil, plugins: nil, pointer_mode: nil, review: nil, review_display: nil, right_menu: nil, show_review_changes: nil, slide_player_background: nil, spellcheck: nil, status_bar: nil, submit_form: nil, toolbar: nil, toolbar_hide_file_name: nil, toolbar_no_tabs: nil, track_changes: nil, ui_theme: nil, unit: nil, word_headings_color: nil, zoom: nil) ⇒ void constructor
• #serialize(strict = nil) ⇒ T.untyped

Constructor Details

#initialize(about: nil, anonymous: nil, autosave: nil, chat: nil, close: nil, comment_author_only: nil, comments: nil, compact_header: nil, compact_toolbar: nil, compatible_features: nil, customer: nil, features: nil, feedback: nil, font: nil, forcesave: nil, goback: nil, help: nil, hide_notes: nil, hide_right_menu: nil, hide_rulers: nil, integration_mode: nil, layout: nil, left_menu: nil, loader_logo: nil, loader_name: nil, logo: nil, macros: nil, macros_mode: nil, mention_share: nil, mobile: nil, mobile_force_view: nil, plugins: nil, pointer_mode: nil, review: nil, review_display: nil, right_menu: nil, show_review_changes: nil, slide_player_background: nil, spellcheck: nil, status_bar: nil, submit_form: nil, toolbar: nil, toolbar_hide_file_name: nil, toolbar_no_tabs: nil, track_changes: nil, ui_theme: nil, unit: nil, word_headings_color: nil, zoom: nil) ⇒ void

Parameters:

• about (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• anonymous (Anonymous, nil) (defaults to: nil) —

  @since 0.1.0

• autosave (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• chat (Boolean, nil) (defaults to: nil) —

  @deprecated Use Document::Permissions#chat instead. This property is deprecated since Document Server version 7.1. @since 0.1.0

• close (Close, nil) (defaults to: nil) —

  @since 0.1.0

• comment_author_only (Boolean, nil) (defaults to: nil) —

  @deprecated Use Document::Permissions#edit_comment_author_only and Document::Permissions#delete_comment_author_only instead. This property is deprecated since Document Server version 6.3. @since 0.1.0

• comments (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• compact_header (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• compact_toolbar (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• compatible_features (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• customer (Customer, nil) (defaults to: nil) —

  @since 0.1.0

• features (Features, nil) (defaults to: nil) —

  @since 0.1.0

• feedback (Feedback, Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• font (Font, nil) (defaults to: nil) —

  @since 0.1.0

• forcesave (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• goback (GoBack, nil) (defaults to: nil) —

  @since 0.1.0

• help (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• hide_notes (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• hide_right_menu (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• hide_rulers (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• integration_mode (IntegrationMode, nil) (defaults to: nil) —

  @since 0.1.0

• layout (Layout, nil) (defaults to: nil) —

  @since 0.1.0

• left_menu (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#left_menu instead. This property is deprecated since Document Server version 7.1. @since 0.1.0

• loader_logo (String, nil) (defaults to: nil) —

  @since 0.1.0

• loader_name (String, nil) (defaults to: nil) —

  @since 0.1.0

• logo (Logo, nil) (defaults to: nil) —

  @since 0.1.0

• macros (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• macros_mode (MacrosMode, nil) (defaults to: nil) —

  @since 0.1.0

• mention_share (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• mobile (Mobile, nil) (defaults to: nil) —

  @since 0.1.0

• mobile_force_view (Boolean, nil) (defaults to: nil) —

  @deprecated Use #mobile instead. This property is deprecated since Document Server version 8.2. @since 0.1.0

• plugins (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• pointer_mode (PointerMode, nil) (defaults to: nil) —

  @since 0.1.0

• review (Review, nil) (defaults to: nil) —

  @since 0.1.0

• review_display (Review::ReviewDisplay, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Review#review_display instead. This property is deprecated since Document Server version 7.0. @since 0.1.0

• right_menu (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#right_menu instead. This property is deprecated since Document Server version 7.1. @since 0.1.0

• show_review_changes (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Review#show_review_changes instead. This property is deprecated since Document Server version 7.0. @since 0.1.0

• slide_player_background (String, nil) (defaults to: nil) —

  @since 0.1.0

• spellcheck (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Features#spellcheck instead. This property is deprecated since Document Server version 7.1. @since 0.1.0

• status_bar (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#status_bar instead. This property is deprecated since Document Server version 7.1. @since 0.1.0

• submit_form (SubmitForm, Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• toolbar (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#toolbar instead. This property is deprecated since Document Server version 7.1. @since 0.1.0

• toolbar_hide_file_name (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• toolbar_no_tabs (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Features#tab_style and Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Features#tab_background instead. This property is deprecated since Document Server version 8.2. @since 0.1.0

• track_changes (Boolean, nil) (defaults to: nil) —

  @deprecated Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Review#track_changes instead. This property is deprecated since Document Server version 7.0. @since 0.1.0

• ui_theme (UiTheme, nil) (defaults to: nil) —

  @since 0.1.0

• unit (Unit, nil) (defaults to: nil) —

  @since 0.1.0

• word_headings_color (String, nil) (defaults to: nil) —

  @since 0.1.0

• zoom (Integer, nil) (defaults to: nil) —

  @since 0.1.0

# File ''

prop :about, T.nilable(T::Boolean), name: "about"
prop :anonymous, T.nilable(Anonymous), name: "anonymous"
prop :autosave, T.nilable(T::Boolean), name: "autosave"
prop :chat, T.nilable(T::Boolean), name: "chat"
prop :close, T.nilable(Close), name: "close"
prop :comment_author_only, T.nilable(T::Boolean), name: "commentAuthorOnly"
prop :comments, T.nilable(T::Boolean), name: "comments"
prop :compact_header, T.nilable(T::Boolean), name: "compactHeader"
prop :compact_toolbar, T.nilable(T::Boolean), name: "compactToolbar"
prop :compatible_features, T.nilable(T::Boolean), name: "compatibleFeatures"
prop :customer, T.nilable(Customer), name: "customer"
prop :features, T.nilable(Features), name: "features"
prop :feedback, T.nilable(T.any(Feedback, T::Boolean)), name: "feedback"
prop :font, T.nilable(Font), name: "font"
prop :forcesave, T.nilable(T::Boolean), name: "forcesave"
prop :goback, T.nilable(GoBack), name: "goback"
prop :help, T.nilable(T::Boolean), name: "help"
prop :hide_notes, T.nilable(T::Boolean), name: "hideNotes"
prop :hide_right_menu, T.nilable(T::Boolean), name: "hideRightMenu"
prop :hide_rulers, T.nilable(T::Boolean), name: "hideRulers"
prop :integration_mode, T.nilable(IntegrationMode), name: "integrationMode"
prop :layout, T.nilable(Layout), name: "layout"
prop :left_menu, T.nilable(T::Boolean), name: "leftMenu"
prop :loader_logo, T.nilable(String), name: "loaderLogo"
prop :loader_name, T.nilable(String), name: "loaderName"
prop :logo, T.nilable(Logo), name: "logo"
prop :macros, T.nilable(T::Boolean), name: "macros"
prop :macros_mode, T.nilable(MacrosMode), name: "macrosMode"
prop :mention_share, T.nilable(T::Boolean), name: "mentionShare"
prop :mobile, T.nilable(Mobile), name: "mobile"
prop :mobile_force_view, T.nilable(T::Boolean), name: "mobileForceView"
prop :plugins, T.nilable(T::Boolean), name: "plugins"
prop :pointer_mode, T.nilable(PointerMode), name: "pointerMode"
prop :review, T.nilable(Review), name: "review"
prop :review_display, T.nilable(Review::ReviewDisplay), name: "reviewDisplay"
prop :right_menu, T.nilable(T::Boolean), name: "rightMenu"
prop :show_review_changes, T.nilable(T::Boolean), name: "showReviewChanges"
prop :slide_player_background, T.nilable(String), name: "slidePlayerBackground"
prop :spellcheck, T.nilable(T::Boolean), name: "spellcheck"
prop :status_bar, T.nilable(T::Boolean), name: "statusBar"
prop :submit_form, T.nilable(T.any(SubmitForm, T::Boolean)), name: "submitForm"
prop :toolbar, T.nilable(T::Boolean), name: "toolbar"
prop :toolbar_hide_file_name, T.nilable(T::Boolean), name: "toolbarHideFileName"
prop :toolbar_no_tabs, T.nilable(T::Boolean), name: "toolbarNoTabs"
prop :track_changes, T.nilable(T::Boolean), name: "trackChanges"
prop :ui_theme, T.nilable(UiTheme), name: "uiTheme"
prop :unit, T.nilable(Unit), name: "unit"
prop :word_headings_color, T.nilable(String), name: "wordHeadingsColor"
prop :zoom, T.nilable(Integer), name: "zoom"

Instance Attribute Details

#about ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :about, T.nilable(T::Boolean), name: "about"

#anonymous ⇒ Anonymous^?

Returns:

• (Anonymous, nil)

Since:

• 0.1.0

# File ''

prop :anonymous, T.nilable(Anonymous), name: "anonymous"

#autosave ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :autosave, T.nilable(T::Boolean), name: "autosave"

#chat ⇒ Boolean^?

Deprecated.

Use Document::Permissions#chat instead. This property is deprecated since Document Server version 7.1.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :chat, T.nilable(T::Boolean), name: "chat"

#close ⇒ Close^?

Returns:

• (Close, nil)

Since:

• 0.1.0

# File ''

prop :close, T.nilable(Close), name: "close"

#comment_author_only ⇒ Boolean^?

Deprecated.

Use Document::Permissions#edit_comment_author_only and Document::Permissions#delete_comment_author_only instead. This property is deprecated since Document Server version 6.3.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :comment_author_only, T.nilable(T::Boolean), name: "commentAuthorOnly"

#comments ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :comments, T.nilable(T::Boolean), name: "comments"

#compact_header ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :compact_header, T.nilable(T::Boolean), name: "compactHeader"

#compact_toolbar ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :compact_toolbar, T.nilable(T::Boolean), name: "compactToolbar"

#compatible_features ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :compatible_features, T.nilable(T::Boolean), name: "compatibleFeatures"

#customer ⇒ Customer^?

Returns:

• (Customer, nil)

Since:

• 0.1.0

# File ''

prop :customer, T.nilable(Customer), name: "customer"

#features ⇒ Features^?

Returns:

• (Features, nil)

Since:

• 0.1.0

# File ''

prop :features, T.nilable(Features), name: "features"

#feedback ⇒ Feedback, ...

Returns:

• (Feedback, Boolean, nil)

Since:

• 0.1.0

# File ''

prop :feedback, T.nilable(T.any(Feedback, T::Boolean)), name: "feedback"

#font ⇒ Font^?

Returns:

• (Font, nil)

Since:

• 0.1.0

# File ''

prop :font, T.nilable(Font), name: "font"

#forcesave ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :forcesave, T.nilable(T::Boolean), name: "forcesave"

#goback ⇒ GoBack^?

Returns:

• (GoBack, nil)

Since:

• 0.1.0

# File ''

prop :goback, T.nilable(GoBack), name: "goback"

#help ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :help, T.nilable(T::Boolean), name: "help"

#hide_notes ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :hide_notes, T.nilable(T::Boolean), name: "hideNotes"

#hide_right_menu ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :hide_right_menu, T.nilable(T::Boolean), name: "hideRightMenu"

#hide_rulers ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :hide_rulers, T.nilable(T::Boolean), name: "hideRulers"

#integration_mode ⇒ IntegrationMode^?

Returns:

• (IntegrationMode, nil)

Since:

• 0.1.0

# File ''

prop :integration_mode, T.nilable(IntegrationMode), name: "integrationMode"

#layout ⇒ Layout^?

Returns:

• (Layout, nil)

Since:

• 0.1.0

# File ''

prop :layout, T.nilable(Layout), name: "layout"

#left_menu ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#left_menu instead. This property is deprecated since Document Server version 7.1.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :left_menu, T.nilable(T::Boolean), name: "leftMenu"

#loader_logo ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :loader_logo, T.nilable(String), name: "loaderLogo"

#loader_name ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :loader_name, T.nilable(String), name: "loaderName"

#logo ⇒ Logo^?

Returns:

• (Logo, nil)

Since:

• 0.1.0

# File ''

prop :logo, T.nilable(Logo), name: "logo"

#macros ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :macros, T.nilable(T::Boolean), name: "macros"

#macros_mode ⇒ MacrosMode^?

Returns:

• (MacrosMode, nil)

Since:

• 0.1.0

# File ''

prop :macros_mode, T.nilable(MacrosMode), name: "macrosMode"

#mention_share ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :mention_share, T.nilable(T::Boolean), name: "mentionShare"

#mobile ⇒ Mobile^?

Returns:

• (Mobile, nil)

Since:

• 0.1.0

# File ''

prop :mobile, T.nilable(Mobile), name: "mobile"

#mobile_force_view ⇒ Boolean^?

Deprecated.

Use #mobile instead. This property is deprecated since Document Server version 8.2.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :mobile_force_view, T.nilable(T::Boolean), name: "mobileForceView"

#plugins ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :plugins, T.nilable(T::Boolean), name: "plugins"

#pointer_mode ⇒ PointerMode^?

Returns:

• (PointerMode, nil)

Since:

• 0.1.0

# File ''

prop :pointer_mode, T.nilable(PointerMode), name: "pointerMode"

#review ⇒ Review^?

Returns:

• (Review, nil)

Since:

• 0.1.0

# File ''

prop :review, T.nilable(Review), name: "review"

#review_display ⇒ Review::ReviewDisplay^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Review#review_display instead. This property is deprecated since Document Server version 7.0.

Returns:

• (Review::ReviewDisplay, nil)

Since:

• 0.1.0

# File ''

prop :review_display, T.nilable(Review::ReviewDisplay), name: "reviewDisplay"

#right_menu ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#right_menu instead. This property is deprecated since Document Server version 7.1.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :right_menu, T.nilable(T::Boolean), name: "rightMenu"

#show_review_changes ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Review#show_review_changes instead. This property is deprecated since Document Server version 7.0.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :show_review_changes, T.nilable(T::Boolean), name: "showReviewChanges"

#slide_player_background ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :slide_player_background, T.nilable(String), name: "slidePlayerBackground"

#spellcheck ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Features#spellcheck instead. This property is deprecated since Document Server version 7.1.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :spellcheck, T.nilable(T::Boolean), name: "spellcheck"

#status_bar ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#status_bar instead. This property is deprecated since Document Server version 7.1.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :status_bar, T.nilable(T::Boolean), name: "statusBar"

#submit_form ⇒ SubmitForm, ...

Returns:

• (SubmitForm, Boolean, nil)

Since:

• 0.1.0

# File ''

prop :submit_form, T.nilable(T.any(SubmitForm, T::Boolean)), name: "submitForm"

#toolbar ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Layout#toolbar instead. This property is deprecated since Document Server version 7.1.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :toolbar, T.nilable(T::Boolean), name: "toolbar"

#toolbar_hide_file_name ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :toolbar_hide_file_name, T.nilable(T::Boolean), name: "toolbarHideFileName"

#toolbar_no_tabs ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Features#tab_style and Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Features#tab_background instead. This property is deprecated since Document Server version 8.2.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :toolbar_no_tabs, T.nilable(T::Boolean), name: "toolbarNoTabs"

#track_changes ⇒ Boolean^?

Deprecated.

Use Onlyoffice::DocsIntegrationSdk::DocumentEditor::Config::EditorConfig::Customization::Review#track_changes instead. This property is deprecated since Document Server version 7.0.

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :track_changes, T.nilable(T::Boolean), name: "trackChanges"

#ui_theme ⇒ UiTheme^?

Returns:

• (UiTheme, nil)

Since:

• 0.1.0

# File ''

prop :ui_theme, T.nilable(UiTheme), name: "uiTheme"

#unit ⇒ Unit^?

Returns:

• (Unit, nil)

Since:

• 0.1.0

# File ''

prop :unit, T.nilable(Unit), name: "unit"

#word_headings_color ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :word_headings_color, T.nilable(String), name: "wordHeadingsColor"

#zoom ⇒ Integer^?

Returns:

• (Integer, nil)

Since:

• 0.1.0

# File ''

prop :zoom, T.nilable(Integer), name: "zoom"

Class Method Details

.from_hash(hash, strict = nil) ⇒ Customization

Parameters:

• hash (T.untyped)
• strict (T.untyped) (defaults to: nil)

Returns:

• (Customization)

Since:

• 0.1.0

# File 'lib/onlyoffice/docs_integration_sdk/document_editor/config.rb', line 1305

def self.from_hash(hash, strict = nil)
  s = T.cast(super(hash, strict), Customization)

  feedback_v = s.feedback
  if !feedback_v.nil? && !feedback_v.is_a?(TrueClass) && !feedback_v.is_a?(FalseClass)
    s.feedback = Feedback.from_hash(feedback_v, strict)
  end

  submit_form_v = s.submit_form
  if !submit_form_v.nil? && !submit_form_v.is_a?(TrueClass) && !submit_form_v.is_a?(FalseClass)
    s.submit_form = SubmitForm.from_hash(submit_form_v, strict)
  end

  s
end

Instance Method Details

#serialize(strict = nil) ⇒ T.untyped

Parameters:

• strict (T.untyped) (defaults to: nil)

Returns:

• (T.untyped)

Since:

• 0.1.0

# File 'lib/onlyoffice/docs_integration_sdk/document_editor/config.rb', line 1323

def serialize(strict = nil)
  h = T.cast(super(strict), T::Hash[T.untyped, T.untyped])

  feedback_v = feedback
  if !feedback_v.nil? && !feedback_v.is_a?(TrueClass) && !feedback_v.is_a?(FalseClass)
    h[Customization.props[:feedback][:name] || "feedback"] = feedback_v.serialize(strict)
  end

  submit_form_v = submit_form
  if !submit_form_v.nil? && !submit_form_v.is_a?(TrueClass) && !submit_form_v.is_a?(FalseClass)
    h[Customization.props[:submit_form][:name] || "submitForm"] = submit_form_v.serialize(strict)
  end

  h
end