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

Inherits:

T::Struct

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

Extended by:

T::Sig

Defined in:

lib/onlyoffice/docs_integration_sdk/document_editor/config.rb

Overview

Since:

• 0.1.0

Defined Under Namespace

Classes: CoEditing, Customization, Embedded, Mode, Plugins, Recent, Template, User

Instance Attribute Summary

• #action_link ⇒ Hash{T.untyped => T.untyped}^?
• #callback_url ⇒ String^?
• #co_editing ⇒ CoEditing^?
• #create_url ⇒ String^?
• #customization ⇒ Customization^?
• #embedded ⇒ Embedded^?
• #lang ⇒ String^?
• #location ⇒ String^? deprecated Deprecated.

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

• #mode ⇒ Mode^?
• #plugins ⇒ Plugins^?
• #recent ⇒ Array<Recent>^?
• #region ⇒ String^?
• #templates ⇒ Array<Template>^?
• #user ⇒ User^?

Class Method Summary

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

Instance Method Summary

• #initialize(action_link: nil, callback_url: nil, co_editing: nil, create_url: nil, lang: nil, location: nil, mode: nil, recent: nil, region: nil, templates: nil, user: nil, customization: nil, embedded: nil, plugins: nil) ⇒ void constructor

Constructor Details

#initialize(action_link: nil, callback_url: nil, co_editing: nil, create_url: nil, lang: nil, location: nil, mode: nil, recent: nil, region: nil, templates: nil, user: nil, customization: nil, embedded: nil, plugins: nil) ⇒ void

Parameters:

• action_link (Hash{T.untyped => T.untyped}, nil) (defaults to: nil) —

  @since 0.1.0

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

  @since 0.1.0

• co_editing (CoEditing, nil) (defaults to: nil) —

  @since 0.1.0

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

  @since 0.1.0

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

  @since 0.1.0

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

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

• mode (Mode, nil) (defaults to: nil) —

  @since 0.1.0

• recent (Array<Recent>, nil) (defaults to: nil) —

  @since 0.1.0

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

  @since 0.1.0

• templates (Array<Template>, nil) (defaults to: nil) —

  @since 0.1.0

• user (User, nil) (defaults to: nil) —

  @since 0.1.0

• customization (Customization, nil) (defaults to: nil) —

  @since 0.1.0

• embedded (Embedded, nil) (defaults to: nil) —

  @since 0.1.0

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

  @since 0.1.0

# File ''

prop :action_link, T.nilable(T::Hash[T.untyped, T.untyped]), name: "actionLink"
prop :callback_url, T.nilable(String), name: "callbackUrl"
prop :co_editing, T.nilable(CoEditing), name: "coEditing"
prop :create_url, T.nilable(String), name: "createUrl"
prop :lang, T.nilable(String), name: "lang"
prop :location, T.nilable(String), name: "location"
prop :mode, T.nilable(Mode), name: "mode"
prop :recent, T.nilable(T::Array[Recent]), name: "recent"
prop :region, T.nilable(String), name: "region"
prop :templates, T.nilable(T::Array[Template]), name: "templates"
prop :user, T.nilable(User), name: "user"
prop :customization, T.nilable(Customization), name: "customization"
prop :embedded, T.nilable(Embedded), name: "embedded"
prop :plugins, T.nilable(Plugins), name: "plugins"

Instance Attribute Details

#action_link ⇒ Hash{T.untyped => T.untyped}^?

Returns:

• (Hash{T.untyped => T.untyped}, nil)

Since:

• 0.1.0

# File ''

prop :action_link, T.nilable(T::Hash[T.untyped, T.untyped]), name: "actionLink"

#callback_url ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :callback_url, T.nilable(String), name: "callbackUrl"

#co_editing ⇒ CoEditing^?

Returns:

• (CoEditing, nil)

Since:

• 0.1.0

# File ''

prop :co_editing, T.nilable(CoEditing), name: "coEditing"

#create_url ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :create_url, T.nilable(String), name: "createUrl"

#customization ⇒ Customization^?

Returns:

• (Customization, nil)

Since:

• 0.1.0

# File ''

prop :customization, T.nilable(Customization), name: "customization"

#embedded ⇒ Embedded^?

Returns:

• (Embedded, nil)

Since:

• 0.1.0

# File ''

prop :embedded, T.nilable(Embedded), name: "embedded"

#lang ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :lang, T.nilable(String), name: "lang"

#location ⇒ String^?

Deprecated.

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

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :location, T.nilable(String), name: "location"

#mode ⇒ Mode^?

Returns:

• (Mode, nil)

Since:

• 0.1.0

# File ''

prop :mode, T.nilable(Mode), name: "mode"

#plugins ⇒ Plugins^?

Returns:

• (Plugins, nil)

Since:

• 0.1.0

# File ''

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

#recent ⇒ Array<Recent>^?

Returns:

• (Array<Recent>, nil)

Since:

• 0.1.0

# File ''

prop :recent, T.nilable(T::Array[Recent]), name: "recent"

#region ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :region, T.nilable(String), name: "region"

#templates ⇒ Array<Template>^?

Returns:

• (Array<Template>, nil)

Since:

• 0.1.0

# File ''

prop :templates, T.nilable(T::Array[Template]), name: "templates"

#user ⇒ User^?

Returns:

• (User, nil)

Since:

• 0.1.0

# File ''

prop :user, T.nilable(User), name: "user"

Class Method Details

.from_hash(hash, strict = nil) ⇒ EditorConfig

Parameters:

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

Returns:

• (EditorConfig)

Since:

• 0.1.0

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

def self.from_hash(hash, strict = nil)
  super(hash, strict)
end