Class SortCollection

Provides a base class for a collection of objects on a remote client.

Hierarchy

Index

Properties

Methods

Properties

public add: (strProperty: string, sortDirection: Microsoft.SharePoint.Client.Search.Query.SortDirection) => void

public clear: () => void

public get_childItemType: () => Object

public get_item: (index: number) => Microsoft.SharePoint.Client.Search.Query.Sort

public itemAt: (index: number) => Microsoft.SharePoint.Client.Search.Query.Sort

Methods

public addChild(obj: T in SP.ClientObjectCollection<T>)

Parameters

  • obj: T in SP.ClientObjectCollection<T>

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public fromJson(obj: any)

Parameters

  • obj: any

public getEnumerator(): IEnumerator

Returns an enumerator that iterates through the collection.

Returns

IEnumerator

public getItemAtIndex(index: number): T in SP.ClientObjectCollection<T>

Parameters

  • index: number

Returns

T in SP.ClientObjectCollection<T>

public get_areItemsAvailable(): boolean

Returns

boolean

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_count(): number

Returns number of items in the collection.

Returns

number

public get_data(): Array<T>

Returns

Array<T>

public get_objectVersion(): string

Returns

string

public get_objectVersion(): string

Returns

string

public get_path(): ObjectPath

Returns

ObjectPath

public get_path(): ObjectPath

Returns

ObjectPath

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public get_typedObject(): ClientObject

Returns

ClientObject

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public refreshLoad()

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public retrieveItems(): ClientObjectPrototype

Gets the data for all of the items in the collection.

Returns

ClientObjectPrototype

public set_objectVersion(value: string)

Parameters

  • value: string

public set_objectVersion(value: string)

Parameters

  • value: string