Class CamlQuery

Specifies a Collaborative Application Markup Language (CAML) query on a list.

Hierarchy

Index

Constructor methods

Methods

Constructor methods

constructor(): CamlQuery

Returns

CamlQuery

Methods

public static createAllFoldersQuery(): CamlQuery

This method creates a Collaborative Application Markup Language (CAML) string that can be used to recursively get all of the folders in a list, including the subfolders.

Returns

CamlQuery

public static createAllItemsQuery(): CamlQuery

This method creates a Collaborative Application Markup Language (CAML) string that can be used to recursively get all of the items in a list, including the items in the subfolders.

Returns

CamlQuery

public customFromJson(obj: any): boolean

Parameters

  • obj: any

Returns

boolean

public customWriteToXml(writer: XmlWriter, serializationContext: SerializationContext): boolean

Parameters

Returns

boolean

public fromJson(obj: any)

Parameters

  • obj: any

public get_datesInUtc(): boolean

Returns true if the query returns dates in Coordinated Universal Time (UTC) format.

Returns

boolean

public get_folderServerRelativeUrl(): string

Server relative URL of a list folder from which results will be returned.

Returns

string

public get_listItemCollectionPosition(): ListItemCollectionPosition

Returns

ListItemCollectionPosition

public get_typeId(): string

This member is reserved for internal use and is not intended to be used directly from your code.

Returns

string

public get_viewXml(): string

Gets value that specifies the XML schema that defines the list view.

Returns

string

public set_datesInUtc(value: boolean)

Sets a value that indicates whether the query returns dates in Coordinated Universal Time (UTC) format.

Parameters

  • value: boolean

public set_folderServerRelativeUrl(value: string)

Sets a value that specifies the server relative URL of a list folder from which results will be returned.

Parameters

  • value: string

public set_listItemCollectionPosition(value: ListItemCollectionPosition)

Sets a value that specifies the information required to get the next page of data for the list view.

Parameters

public set_viewXml(value: string)

Sets value that specifies the XML schema that defines the list view. It must be null, empty, or an XML fragment that conforms to the ViewDefinition type.

Parameters

  • value: string

public writeToXml(writer: XmlWriter, serializationContext: SerializationContext)

Parameters