Class CollectionObject

Class returned by methods such as getCategoryCollection

Hierarchy (view full)

RemoteDataSet
- CollectionObject

Index

Constructors

Properties

dataSetName? detail ds entity id requestObject responseObject

Accessors

Methods

afterExecute asJsonRpc findAttachment findDataSetArray findFunc findFunc2 findFuncArray findFuncArray2 findListArray registerObject

Constructors

constructor

new CollectionObject(remoteAPI, entity, detail): CollectionObject
Parameters
- remoteAPI: JsonRpcApi
- entity: string
- detail: string
Returns CollectionObject
Overrides RemoteDataSet.constructor
- Defined in src/crm-rpc/rpc-objects/dataset.ts:362

Properties

`Protected` `Optional` dataSetName

dataSetName?: string

`Private` detail

detail: string

`Protected` ds

ds: null | DataSetInternal = null

`Private` entity

entity: string

`Protected` id

id: string

`Protected` requestObject

requestObject: null | RpcNamedOperation

`Protected` responseObject

responseObject: {}

Type declaration

Accessors

`Protected` api

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

item

get item(): null | JSONPrimitiveRecord
When exists, the first item of the items, else null

Returns null | JSONPrimitiveRecord
Inherited from RemoteDataSet.item
- Defined in src/crm-rpc/rpc-objects/dataset.ts:120

items

get items(): JSONPrimitiveRecord[]
The to array converted dataset

Returns JSONPrimitiveRecord[]
Inherited from RemoteDataSet.items
- Defined in src/crm-rpc/rpc-objects/dataset.ts:113

Methods

`Protected` afterExecute

afterExecute(): void
Returns void
Inherited from RemoteDataSet.afterExecute
- Defined in src/crm-rpc/rpc-objects/dataset.ts:103

`Protected` asJsonRpc

asJsonRpc(): RpcNamedOperation
Returns RpcNamedOperation
Overrides RemoteDataSet.asJsonRpc
- Defined in src/crm-rpc/rpc-objects/dataset.ts:367

`Protected` findAttachment

findAttachment(resp, key): undefined | JSONPrimitiveRecord
Parameters
- resp: JSONPrimitiveRecord
- key: string
Returns undefined | JSONPrimitiveRecord
Inherited from RemoteDataSet.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 RemoteDataSet.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 RemoteDataSet.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 RemoteDataSet.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 RemoteDataSet.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 RemoteDataSet.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 RemoteDataSet.findListArray
- Defined in src/crm-rpc/rpc-objects/rpc-object.ts:52

`Protected` registerObject

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