Class PropertyObject

Class returned by API property operation such as currentdatabasealias, currentuserfullname

Hierarchy

StringObject
- PropertyObject

Index

Constructors

Properties

id name operationName requestObject responseObject result

Accessors

Methods

afterExecute asJsonRpc findAttachment findDataSetArray findFunc findFunc2 findFuncArray findFuncArray2 findListArray registerObject

Constructors

constructor

new PropertyObject(remoteAPI, name): PropertyObject
Parameters
- remoteAPI: JsonRpcApi
- name: string
Returns PropertyObject
Overrides StringObject.constructor
- Defined in src/crm-rpc/rpc-objects/base-type.ts:30

Properties

`Protected` id

id: string

name

name: string

`Protected` operationName

operationName: string = ""

`Protected` requestObject

requestObject: null | RpcNamedOperation

`Protected` responseObject

responseObject: {}

Type declaration

result

result: string = ""

Accessors

`Protected` api

get api(): JsonRpcApi
Returns JsonRpcApi
Inherited from StringObject.api
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:21

Methods

`Protected` afterExecute

afterExecute(): void
Returns void
Inherited from StringObject.afterExecute
- Defined in src/crm-rpc/rpc-objects/base-type.ts:17

`Protected` asJsonRpc

asJsonRpc(): RpcNamedOperation
Returns RpcNamedOperation
Overrides StringObject.asJsonRpc
- Defined in src/crm-rpc/rpc-objects/base-type.ts:36

`Protected` findAttachment

findAttachment(resp, key): undefined | JSONPrimitiveRecord
Parameters
- resp: JSONPrimitiveRecord
- key: string
Returns undefined | JSONPrimitiveRecord
Inherited from StringObject.findAttachment
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:56

`Protected` findDataSetArray

findDataSetArray(resp, dataSetName?): JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- dataSetName: string = "dataset"
Returns JSONPrimitiveRecord[]
Inherited from StringObject.findDataSetArray
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:37

`Protected` findFunc

findFunc(resp, name): any
Parameters
- resp: JSONPrimitiveRecord
- name: string
Returns any
Inherited from StringObject.findFunc
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:61

`Protected` findFunc2

findFunc2(resp, name, name2, value2): any
Parameters
- resp: JSONPrimitiveRecord
- name: string
- name2: string
- value2: string | number
Returns any
Inherited from StringObject.findFunc2
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:66

`Protected` findFuncArray

findFuncArray(resp, name): null | JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- name: string
Returns null | JSONPrimitiveRecord[]
Inherited from StringObject.findFuncArray
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:71

`Protected` findFuncArray2

findFuncArray2(resp, name, name2, value2): null | JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- name: string
- name2: string
- value2: string | number
Returns null | JSONPrimitiveRecord[]
Inherited from StringObject.findFuncArray2
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:76

`Protected` findListArray

findListArray(resp, listName?): JSONPrimitiveRecord[]
Parameters
- resp: JSONPrimitiveRecord
- listName: string = "stringlist"
Returns JSONPrimitiveRecord[]
Inherited from StringObject.findListArray
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:52

`Protected` registerObject

registerObject(object): void
Parameters
- object: RpcObject
Returns void
Inherited from StringObject.registerObject
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:33