Class SettingObject

Class returned by getSetting operation

Hierarchy

  • StringObject
    • SettingObject

Constructors

constructor

Properties

asString id module name operationName requestObject responseObject result

Accessors

api

Methods

afterExecute asJsonRpc findAttachment findDataSetArray findFunc findFunc2 findFuncArray findFuncArray2 findListArray registerObject

Constructors

constructor

  • new SettingObject(remoteAPI, module, name, asString?): SettingObject

  • Parameters

    • remoteAPI: JsonRpcApi
    • module: string

      The name of the module (JSON object) that owns the setting.

    • name: string

      The name of the setting.

    • asString: boolean = true

      If true, the settings of type TDateTime will be returned as a string formatted with the ShortDateTime format. If false, it will be returned as a float value.

    Returns SettingObject

Properties

Private asString

asString: boolean = true

If true, the settings of type TDateTime will be returned as a string formatted with the ShortDateTime format. If false, it will be returned as a float value.

Protected id

id: string

Private module

module: string

The name of the module (JSON object) that owns the setting.

Private name

name: string

The name of the setting.

Protected operationName

operationName: string = "getsetting"

Protected requestObject

requestObject: null | RpcNamedOperation

Protected responseObject

responseObject: {}

Type declaration

    result

    result: string = ""

    Accessors

    Protected api

    Methods

    Protected afterExecute

    Protected asJsonRpc

    • asJsonRpc(): {
          #id: string;
          @func: {
              @name: string;
              asstring: boolean;
              module: string;
              name: string;
          }[];
          @name: string;
      }
    • Protected

      Returns {
          #id: string;
          @func: {
              @name: string;
              asstring: boolean;
              module: string;
              name: string;
          }[];
          @name: string;
      }

      • #id: string
      • @func: {
            @name: string;
            asstring: boolean;
            module: string;
            name: string;
        }[]
      • @name: string

    Protected findAttachment

    Protected findDataSetArray

    Protected findFunc

    Protected findFunc2

    Protected findFuncArray

    Protected findFuncArray2

    Protected findListArray

    Protected registerObject

    Settings

    Member Visibility

    Theme

    On This Page

    constructorasStringidmodulenameoperationNamerequestObjectresponseObjectresultapiafterExecuteasJsonRpcfindAttachmentfindDataSetArrayfindFuncfindFunc2findFuncArrayfindFuncArray2findListArrayregisterObject