Class List<T>

List

Type Parameters

T = Types.SP.ListItem

Hierarchy

List

Constructors

constructor

new List<T>(props): List<T>
Type Parameters
- T = ListItem
Parameters
- props: IListProps<T>
Returns List<T>
- Defined in src/common/list.ts:124

Properties

`Private` _camlQuery

_camlQuery: string = null

Public Properties

`Private` _items

_items: T[] = null

`Private` _listContentTypes

_listContentTypes: ContentTypeOData[] = null

`Private` _listFields

_listFields: Field[] = null

`Private` _listId

_listId: string = null

`Private` _listInfo

_listInfo: List = null

`Private` _listName

_listName: string = null

`Private` _listUrl

_listUrl: string = null

`Private` _listViews

_listViews: ViewOData[] = null

`Private` _odata

_odata: IODataQuery = null

`Private` _onInitError

_onInitError: ((...args) => void) = null

Type declaration

- (...args): void
- Private Properties
  Parameters
  - Rest ...args: any[]
  Returns void

`Private` `Optional` _onInitialized

_onInitialized?: (() => void) = null

Type declaration

- (): void
- Returns void

`Private` `Optional` _onItemLoading

_onItemLoading?: ((item?) => void) = null

Type declaration

- (item?): void
- Parameters
  - Optional item: T
  Returns void

`Private` `Optional` _onItemsLoaded

_onItemsLoaded?: ((items?) => void) = null

Type declaration

- (items?): void
- Parameters
  - Optional items: T[]
  Returns void

`Private` _onLoadFormError

_onLoadFormError: ((...args) => void) = null

Type declaration

- (...args): void
- Parameters
  - Rest ...args: any[]
  Returns void

`Private` `Optional` _onRefreshItems

_onRefreshItems?: ((items?) => void | PromiseLike<any>) = null

Type declaration

- (items?): void | PromiseLike<any>
- Parameters
  - Optional items: T[]
  Returns void | PromiseLike<any>

`Private` _onResetForm

_onResetForm: (() => void) = null

Type declaration

- (): void
- Returns void

`Private` _requestDigest

_requestDigest: string = null

`Private` _viewName

_viewName: string = null

`Private` _viewXml

_viewXml: string = null

`Private` _webUrl

_webUrl: string = null

Accessors

CAMLQuery

get CAMLQuery(): string
Returns string
- Defined in src/common/list.ts:32

EditForm

get EditForm(): IListFormEdit
Returns IListFormEdit
- Defined in src/common/list.ts:35

EditForms

get EditForms(): IListFormEdit[]
Returns IListFormEdit[]
- Defined in src/common/list.ts:38

Items

get Items(): T[]
Returns T[]
- Defined in src/common/list.ts:65

ListContentTypes

get ListContentTypes(): ContentTypeOData[]
Returns ContentTypeOData[]
- Defined in src/common/list.ts:42

ListFields

get ListFields(): Field[]
Returns Field[]
- Defined in src/common/list.ts:46

ListId

get ListId(): string
Returns string
- Defined in src/common/list.ts:69

ListInfo

get ListInfo(): List
Returns List
- Defined in src/common/list.ts:50

ListName

get ListName(): string
Returns string
- Defined in src/common/list.ts:73

ListSettingsUrl

get ListSettingsUrl(): string
Returns string
- Defined in src/common/list.ts:53

ListUrl

get ListUrl(): string
Returns string
- Defined in src/common/list.ts:57

ListViews

get ListViews(): ViewOData[]
Returns ViewOData[]
- Defined in src/common/list.ts:61

OData

get OData(): IODataQuery
Returns IODataQuery
- Defined in src/common/list.ts:77

ViewForm

get ViewForm(): IListFormDisplay
Returns IListFormDisplay
- Defined in src/common/list.ts:80

ViewForms

get ViewForms(): IListFormDisplay[]
Returns IListFormDisplay[]
- Defined in src/common/list.ts:83

ViewName

get ViewName(): string
Returns string
- Defined in src/common/list.ts:87

ViewXml

get ViewXml(): string
Returns string
- Defined in src/common/list.ts:91

WebUrl

get WebUrl(): string
Returns string
- Defined in src/common/list.ts:95

Methods

`Private` clear

clear(props): void
Parameters
- props: IItemFormCreateProps | IItemFormEditProps | IItemFormViewProps
Returns void
- Defined in src/common/list.ts:168

createItem

createItem(values): PromiseLike<T>
Parameters
- values: any
Returns PromiseLike<T>
- Defined in src/common/list.ts:184

deleteItem

deleteItem(itemId): PromiseLike<void>
Parameters
- itemId: number
Returns PromiseLike<void>
- Defined in src/common/list.ts:193

editForm

editForm(props): void
Parameters
- props: IItemFormEditProps
Returns void
- Defined in src/common/list.ts:214

getChanges

getChanges(id, defaultFields?): PromiseLike<any>
Parameters
- id: number
- defaultFields: string[] = []
Returns PromiseLike<any>
- Defined in src/common/list.ts:223

getField

getField(name): any
Parameters
- name: string
Returns any
- Defined in src/common/list.ts:282

getFieldById

getFieldById(id?): Field
Parameters
- id: string = ""
Returns Field
- Defined in src/common/list.ts:306

getItem

getItem(id): T
Parameters
- id: number
Returns T
- Defined in src/common/list.ts:325

`Private` init

init(): PromiseLike<void>
Returns PromiseLike<void>
- Defined in src/common/list.ts:342

`Private` loadItem

loadItem(itemId, query?): PromiseLike<T>
Parameters
- itemId: number
- query: IODataQuery = ...
Returns PromiseLike<T>
- Defined in src/common/list.ts:417

`Private` loadItems

loadItems(query?): PromiseLike<T[]>
Parameters
- Optional query: IODataQuery
Returns PromiseLike<T[]>
- Defined in src/common/list.ts:465

`Private` loadItemsByCAMLQuery

loadItemsByCAMLQuery(): PromiseLike<T[]>
Returns PromiseLike<T[]>
- Defined in src/common/list.ts:481

`Private` loadItemsByQuery

loadItemsByQuery(query?): PromiseLike<T[]>
Parameters
- query: IODataQuery = ...
Returns PromiseLike<T[]>
- Defined in src/common/list.ts:514

`Private` loadItemsByView

loadItemsByView(): PromiseLike<T[]>
Returns PromiseLike<T[]>
- Defined in src/common/list.ts:544

newForm

newForm(props): void
Parameters
- props: IItemFormCreateProps
Returns void
- Defined in src/common/list.ts:577

refresh

refresh(query?): PromiseLike<T[]>
Parameters
- query: IODataQuery = ...
Returns PromiseLike<T[]>
- Defined in src/common/list.ts:586

`Private` refreshContextInfo

refreshContextInfo(): PromiseLike<void>
Returns PromiseLike<void>
- Defined in src/common/list.ts:611

refreshItem

refreshItem(itemId, query?): PromiseLike<T>
Parameters
- itemId: number
- query: IODataQuery = ...
Returns PromiseLike<T>
- Defined in src/common/list.ts:630

save

save(bypassValidation?): PromiseLike<T>
Parameters
- Optional bypassValidation: boolean
Returns PromiseLike<T>
- Defined in src/common/list.ts:636

updateItem

updateItem(itemId, values): PromiseLike<void>
Parameters
- itemId: number
- values: any
Returns PromiseLike<void>
- Defined in src/common/list.ts:642

viewForm

viewForm(props): void
Parameters
- props: IItemFormViewProps
Returns void
- Defined in src/common/list.ts:651

Class List<T>

Type Parameters

T = Types.SP.ListItem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = ListItem

Parameters

props: IListProps<T>

Returns List<T>

Properties

Private _camlQuery

Private _items

Private _listContentTypes

Private _listFields

Private _listId

Private _listInfo

Private _listName

Private _listUrl

Private _listViews

Private _odata

Private _onInitError

Type declaration

Parameters

Rest ...args: any[]

Returns void

Private Optional _onInitialized

Type declaration

Returns void

Private Optional _onItemLoading

Type declaration

Parameters

Optional item: T

Returns void

Private Optional _onItemsLoaded

Type declaration

Parameters

Optional items: T[]

Returns void

Private _onLoadFormError

Type declaration

Parameters

Rest ...args: any[]

Returns void

Private Optional _onRefreshItems

Type declaration

Parameters

Optional items: T[]

Returns void | PromiseLike<any>

Private _onResetForm

Type declaration

Returns void

Private _requestDigest

Private _viewName

Private _viewXml

Private _webUrl

Accessors

CAMLQuery

Returns string

EditForm

Returns IListFormEdit

EditForms

Returns IListFormEdit[]

Items

Returns T[]

ListContentTypes

Returns ContentTypeOData[]

ListFields

Returns Field[]

ListId

Returns string

ListInfo

Returns List

ListName

`Private` _camlQuery

`Private` _items

`Private` _listContentTypes

`Private` _listFields

`Private` _listId

`Private` _listInfo

`Private` _listName

`Private` _listUrl

`Private` _listViews

`Private` _odata

`Private` _onInitError

`Rest` ...args: any[]

`Private` `Optional` _onInitialized

`Private` `Optional` _onItemLoading

`Optional` item: T

`Private` `Optional` _onItemsLoaded

`Optional` items: T[]

`Private` _onLoadFormError

`Rest` ...args: any[]

`Private` `Optional` _onRefreshItems

`Optional` items: T[]

`Private` _onResetForm

`Private` _requestDigest

`Private` _viewName

`Private` _viewXml

`Private` _webUrl

`Private` clear

`Private` init

`Private` loadItem

`Private` loadItems

`Optional` query: IODataQuery

`Private` loadItemsByCAMLQuery

`Private` loadItemsByQuery