Options
All
  • Public
  • Public/Protected
  • All
Menu

IListQuery

Hierarchy

Index

Properties

Methods

Properties

Optional AllowContentTypes

AllowContentTypes: boolean

Optional AllowDeletion

AllowDeletion: boolean

Optional BaseTemplate

BaseTemplate: number

Optional BaseType

BaseType: number

Optional BrowserFileHandling

BrowserFileHandling: number

ContentTypes

ContentTypes: IBaseResults<ContentType> & ContentTypeCollectionMethods

Optional ContentTypesEnabled

ContentTypesEnabled: boolean

Optional CrawlNonDefaultViews

CrawlNonDefaultViews: boolean

CreatablesInfo

Optional Created

Created: any

Optional CurrentChangeToken

CurrentChangeToken: ChangeToken

Optional CustomActionElements

CustomActionElements: CustomActionElementCollection

Optional DataSource

DataSource: ListDataSource

Optional DefaultContentApprovalWorkflowId

DefaultContentApprovalWorkflowId: any

Optional DefaultDisplayFormUrl

DefaultDisplayFormUrl: string

Optional DefaultEditFormUrl

DefaultEditFormUrl: string

Optional DefaultItemOpenUseListSetting

DefaultItemOpenUseListSetting: boolean

Optional DefaultNewFormUrl

DefaultNewFormUrl: string

DefaultView

Optional DefaultViewPath

DefaultViewPath: ResourcePath

Optional DefaultViewUrl

DefaultViewUrl: string

Optional Description

Description: string

DescriptionResource

DescriptionResource: UserResource & UserResourceCollections

Optional Direction

Direction: string

Optional DisableGridEditing

DisableGridEditing: boolean

Optional DocumentTemplateUrl

DocumentTemplateUrl: string

Optional DraftVersionVisibility

DraftVersionVisibility: number

Optional EffectiveBasePermissions

EffectiveBasePermissions: BasePermissions

Optional EffectiveBasePermissionsForUI

EffectiveBasePermissionsForUI: BasePermissions

Optional EnableAssignToEmail

EnableAssignToEmail: boolean

Optional EnableAttachments

EnableAttachments: boolean

Optional EnableFolderCreation

EnableFolderCreation: boolean

Optional EnableMinorVersions

EnableMinorVersions: boolean

Optional EnableModeration

EnableModeration: boolean

Optional EnableRequestSignOff

EnableRequestSignOff: boolean

Optional EnableVersioning

EnableVersioning: boolean

Optional EntityTypeName

EntityTypeName: string

EventReceivers

Optional ExcludeFromOfflineClient

ExcludeFromOfflineClient: boolean

Optional ExemptFromBlockDownloadOfNonViewableFiles

ExemptFromBlockDownloadOfNonViewableFiles: boolean

Fields

Fields: IBaseResults<Field> & FieldCollectionMethods

Optional FileSavePostProcessingEnabled

FileSavePostProcessingEnabled: boolean

FirstUniqueAncestorSecurableObject

FirstUniqueAncestorSecurableObject: SecurableObject & SecurableObjectCollections

Optional ForceCheckout

ForceCheckout: boolean

Forms

Forms: IBaseResults<Form> & FormCollectionMethods

Optional HasExternalDataSource

HasExternalDataSource: boolean

Optional HasUniqueRoleAssignments

HasUniqueRoleAssignments: boolean

Optional Hidden

Hidden: boolean

Optional Id

Id: any

Optional ImagePath

ImagePath: ResourcePath

Optional ImageUrl

ImageUrl: string

InformationRightsManagementSettings

Optional IrmEnabled

IrmEnabled: boolean

Optional IrmExpire

IrmExpire: boolean

Optional IrmReject

IrmReject: boolean

Optional IsApplicationList

IsApplicationList: boolean

Optional IsCatalog

IsCatalog: boolean

Optional IsEnterpriseGalleryLibrary

IsEnterpriseGalleryLibrary: boolean

Optional IsPrivate

IsPrivate: boolean

Optional IsSiteAssetsLibrary

IsSiteAssetsLibrary: boolean

Optional IsSystemList

IsSystemList: boolean

Optional ItemCount

ItemCount: number

Items

Items: IBaseResults<ListItem> & ListItemCollectionMethods

Optional LastItemDeletedDate

LastItemDeletedDate: any

Optional LastItemModifiedDate

LastItemModifiedDate: any

Optional LastItemUserModifiedDate

LastItemUserModifiedDate: any

Optional ListExperienceOptions

ListExperienceOptions: number

Optional ListItemEntityTypeFullName

ListItemEntityTypeFullName: string

Optional MajorVersionLimit

MajorVersionLimit: number

Optional MajorWithMinorVersionsLimit

MajorWithMinorVersionsLimit: number

Optional MultipleDataList

MultipleDataList: boolean

Optional NoCrawl

NoCrawl: boolean

Optional OnQuickLaunch

OnQuickLaunch: boolean

Optional PageRenderType

PageRenderType: number

ParentWeb

Optional ParentWebPath

ParentWebPath: ResourcePath

Optional ParentWebUrl

ParentWebUrl: string

Optional ParserDisabled

ParserDisabled: boolean

Optional ReadSecurity

ReadSecurity: number

RoleAssignments

RoleAssignments: IBaseResults<RoleAssignment> & RoleAssignmentCollectionMethods

RootFolder

Optional SchemaXml

SchemaXml: string

Optional ServerTemplateCanCreateFolders

ServerTemplateCanCreateFolders: boolean

Subscriptions

Subscriptions: IBaseResults<Subscription> & SubscriptionCollectionMethods

Optional TemplateFeatureId

TemplateFeatureId: any

Optional Title

Title: string

TitleResource

UserCustomActions

UserCustomActions: IBaseResults<UserCustomAction> & UserCustomActionCollectionMethods

Optional ValidationFormula

ValidationFormula: string

Optional ValidationMessage

ValidationMessage: string

Views

Views: IBaseResults<View> & ViewCollectionMethods

WorkflowAssociations

WorkflowAssociations: IBaseResults<WorkflowAssociation> & WorkflowAssociationCollectionMethods

Optional WriteSecurity

WriteSecurity: number

existsFl

existsFl: boolean

True, if the object exists, false otherwise.

response

response: string

The response

Methods

addItem

addItemUsingPath

addValidateUpdateItem

  • addValidateUpdateItem(listItemCreateInfo?: ListItemCreationInformation, formValues?: Array<ListItemFormUpdateValue>, bNewDocumentUpdate?: boolean, checkInComment?: string): IBaseCollection<ListItemFormUpdateValue>
  • Parameters

    • Optional listItemCreateInfo: ListItemCreationInformation
    • Optional formValues: Array<ListItemFormUpdateValue>
    • Optional bNewDocumentUpdate: boolean
    • Optional checkInComment: string

    Returns IBaseCollection<ListItemFormUpdateValue>

addValidateUpdateItemUsingPath

  • addValidateUpdateItemUsingPath(listItemCreateInfo?: ListItemCreationInformationUsingPath, formValues?: Array<ListItemFormUpdateValue>, bNewDocumentUpdate?: boolean, checkInComment?: string): IBaseCollection<ListItemFormUpdateValue>
  • Parameters

    • Optional listItemCreateInfo: ListItemCreationInformationUsingPath
    • Optional formValues: Array<ListItemFormUpdateValue>
    • Optional bNewDocumentUpdate: boolean
    • Optional checkInComment: string

    Returns IBaseCollection<ListItemFormUpdateValue>

breakRoleInheritance

  • breakRoleInheritance(copyRoleAssignments?: boolean, clearSubscopes?: boolean): IBaseExecution<any>

bulkValidateUpdateListItems

  • bulkValidateUpdateListItems(itemIds?: Array<number>, formValues?: Array<ListItemFormUpdateValue>, bNewDocumentUpdate?: boolean, checkInComment?: string, folderPath?: string): IBaseCollection<ListItemFormUpdateValue>
  • Parameters

    • Optional itemIds: Array<number>
    • Optional formValues: Array<ListItemFormUpdateValue>
    • Optional bNewDocumentUpdate: boolean
    • Optional checkInComment: string
    • Optional folderPath: string

    Returns IBaseCollection<ListItemFormUpdateValue>

createDocumentAndGetEditLink

  • createDocumentAndGetEditLink(fileName?: string, folderPath?: string, documentTemplateType?: number, templateUrl?: string): IBaseExecution<string>

createDocumentWithDefaultName

  • createDocumentWithDefaultName(folderPath?: string, extension?: string): IBaseExecution<string>

createMappedView

delete

  • delete(): IBaseExecution<any>
  • Returns IBaseExecution<any>

ensureSignoffStatusField

getBloomFilter

getBloomFilterWithCustomFields

  • getBloomFilterWithCustomFields(listItemStartingID?: number, internalFieldNames?: Array<string>): IBaseExecution<ListBloomFilter>

getChanges

  • getChanges(query?: ChangeQuery): IBaseCollection<Change>

getCheckedOutFiles

getItemById

getItemByStringId

getItemByUniqueId

getItems

getItemsByQuery

getListItemChangesSinceToken

  • getListItemChangesSinceToken(query?: ChangeLogItemQuery): IBaseExecution<any>

getMappedApp

getMappedApps

getRelatedFields

getSpecialFolderUrl

  • getSpecialFolderUrl(type?: number, bForceCreate?: boolean, existingFolderGuid?: any): IBaseExecution<string>
  • Parameters

    • Optional type: number
    • Optional bForceCreate: boolean
    • Optional existingFolderGuid: any

    Returns IBaseExecution<string>

getUserEffectivePermissions

  • getUserEffectivePermissions(userName?: string): IBaseExecution<BasePermissions>

getView

getWebDavUrl

  • getWebDavUrl(sourceUrl?: string): IBaseExecution<string>
  • Parameters

    • Optional sourceUrl: string

    Returns IBaseExecution<string>

publishMappedView

recycle

  • recycle(): IBaseExecution<any>
  • Returns IBaseExecution<any>

renderExtendedListFormData

  • renderExtendedListFormData(itemId?: number, formId?: string, mode?: number, options?: number, cutoffVersion?: number): IBaseExecution<string>

renderListContextMenuData

  • renderListContextMenuData(CascDelWarnMessage?: string, CustomAction?: string, Field?: string, ID?: string, InplaceFullListSearch?: string, InplaceSearchQuery?: string, IsCSR?: string, IsXslView?: string, ItemId?: string, ListViewPageUrl?: string, OverrideScope?: string, RootFolder?: string, View?: string, ViewCount?: string): IBaseExecution<any>
  • Parameters

    • Optional CascDelWarnMessage: string
    • Optional CustomAction: string
    • Optional Field: string
    • Optional ID: string
    • Optional InplaceFullListSearch: string
    • Optional InplaceSearchQuery: string
    • Optional IsCSR: string
    • Optional IsXslView: string
    • Optional ItemId: string
    • Optional ListViewPageUrl: string
    • Optional OverrideScope: string
    • Optional RootFolder: string
    • Optional View: string
    • Optional ViewCount: string

    Returns IBaseExecution<any>

renderListData

  • renderListData(viewXml?: string): IBaseExecution<string>

renderListDataAsStream

  • renderListDataAsStream(parameters?: RenderListDataParameters, CascDelWarnMessage?: string, CustomAction?: string, DrillDown?: string, Field?: string, FieldInternalName?: string, Filter?: string, FilterData?: string, FilterData1?: string, FilterData10?: string, FilterData2?: string, FilterData3?: string, FilterData4?: string, FilterData5?: string, FilterData6?: string, FilterData7?: string, FilterData8?: string, FilterData9?: string, FilterField?: string, FilterField1?: string, FilterField10?: string, FilterField2?: string, FilterField3?: string, FilterField4?: string, FilterField5?: string, FilterField6?: string, FilterField7?: string, FilterField8?: string, FilterField9?: string, FilterFields?: string, FilterFields1?: string, FilterFields10?: string, FilterFields2?: string, FilterFields3?: string, FilterFields4?: string, FilterFields5?: string, FilterFields6?: string, FilterFields7?: string, FilterFields8?: string, FilterFields9?: string, FilterLookupId?: string, FilterLookupId1?: string, FilterLookupId10?: string, FilterLookupId2?: string, FilterLookupId3?: string, FilterLookupId4?: string, FilterLookupId5?: string, FilterLookupId6?: string, FilterLookupId7?: string, FilterLookupId8?: string, FilterLookupId9?: string, FilterOp?: string, FilterOp1?: string, FilterOp10?: string, FilterOp2?: string, FilterOp3?: string, FilterOp4?: string, FilterOp5?: string, FilterOp6?: string, FilterOp7?: string, FilterOp8?: string, FilterOp9?: string, FilterValue?: string, FilterValue1?: string, FilterValue10?: string, FilterValue2?: string, FilterValue3?: string, FilterValue4?: string, FilterValue5?: string, FilterValue6?: string, FilterValue7?: string, FilterValue8?: string, FilterValue9?: string, FilterValues?: string, FilterValues1?: string, FilterValues10?: string, FilterValues2?: string, FilterValues3?: string, FilterValues4?: string, FilterValues5?: string, FilterValues6?: string, FilterValues7?: string, FilterValues8?: string, FilterValues9?: string, GroupString?: string, HasOverrideSelectCommand?: string, ID?: string, InplaceFullListSearch?: string, InplaceSearchQuery?: string, IsCSR?: string, IsGroupRender?: string, IsXslView?: string, ListViewPageUrl?: string, OverrideScope?: string, OverrideSelectCommand?: string, PageFirstRow?: string, PageLastRow?: string, RootFolder?: string, RootFolderUniqueId?: string, SortDir?: string, SortDir1?: string, SortDir10?: string, SortDir2?: string, SortDir3?: string, SortDir4?: string, SortDir5?: string, SortDir6?: string, SortDir7?: string, SortDir8?: string, SortDir9?: string, SortField?: string, SortField1?: string, SortField10?: string, SortField2?: string, SortField3?: string, SortField4?: string, SortField5?: string, SortField6?: string, SortField7?: string, SortField8?: string, SortField9?: string, SortFields?: string, SortFieldValues?: string, View?: string, ViewCount?: string, ViewId?: string, ViewPath?: string, WebPartId?: string): IBaseExecution<any>
  • Parameters

    • Optional parameters: RenderListDataParameters
    • Optional CascDelWarnMessage: string
    • Optional CustomAction: string
    • Optional DrillDown: string
    • Optional Field: string
    • Optional FieldInternalName: string
    • Optional Filter: string
    • Optional FilterData: string
    • Optional FilterData1: string
    • Optional FilterData10: string
    • Optional FilterData2: string
    • Optional FilterData3: string
    • Optional FilterData4: string
    • Optional FilterData5: string
    • Optional FilterData6: string
    • Optional FilterData7: string
    • Optional FilterData8: string
    • Optional FilterData9: string
    • Optional FilterField: string
    • Optional FilterField1: string
    • Optional FilterField10: string
    • Optional FilterField2: string
    • Optional FilterField3: string
    • Optional FilterField4: string
    • Optional FilterField5: string
    • Optional FilterField6: string
    • Optional FilterField7: string
    • Optional FilterField8: string
    • Optional FilterField9: string
    • Optional FilterFields: string
    • Optional FilterFields1: string
    • Optional FilterFields10: string
    • Optional FilterFields2: string
    • Optional FilterFields3: string
    • Optional FilterFields4: string
    • Optional FilterFields5: string
    • Optional FilterFields6: string
    • Optional FilterFields7: string
    • Optional FilterFields8: string
    • Optional FilterFields9: string
    • Optional FilterLookupId: string
    • Optional FilterLookupId1: string
    • Optional FilterLookupId10: string
    • Optional FilterLookupId2: string
    • Optional FilterLookupId3: string
    • Optional FilterLookupId4: string
    • Optional FilterLookupId5: string
    • Optional FilterLookupId6: string
    • Optional FilterLookupId7: string
    • Optional FilterLookupId8: string
    • Optional FilterLookupId9: string
    • Optional FilterOp: string
    • Optional FilterOp1: string
    • Optional FilterOp10: string
    • Optional FilterOp2: string
    • Optional FilterOp3: string
    • Optional FilterOp4: string
    • Optional FilterOp5: string
    • Optional FilterOp6: string
    • Optional FilterOp7: string
    • Optional FilterOp8: string
    • Optional FilterOp9: string
    • Optional FilterValue: string
    • Optional FilterValue1: string
    • Optional FilterValue10: string
    • Optional FilterValue2: string
    • Optional FilterValue3: string
    • Optional FilterValue4: string
    • Optional FilterValue5: string
    • Optional FilterValue6: string
    • Optional FilterValue7: string
    • Optional FilterValue8: string
    • Optional FilterValue9: string
    • Optional FilterValues: string
    • Optional FilterValues1: string
    • Optional FilterValues10: string
    • Optional FilterValues2: string
    • Optional FilterValues3: string
    • Optional FilterValues4: string
    • Optional FilterValues5: string
    • Optional FilterValues6: string
    • Optional FilterValues7: string
    • Optional FilterValues8: string
    • Optional FilterValues9: string
    • Optional GroupString: string
    • Optional HasOverrideSelectCommand: string
    • Optional ID: string
    • Optional InplaceFullListSearch: string
    • Optional InplaceSearchQuery: string
    • Optional IsCSR: string
    • Optional IsGroupRender: string
    • Optional IsXslView: string
    • Optional ListViewPageUrl: string
    • Optional OverrideScope: string
    • Optional OverrideSelectCommand: string
    • Optional PageFirstRow: string
    • Optional PageLastRow: string
    • Optional RootFolder: string
    • Optional RootFolderUniqueId: string
    • Optional SortDir: string
    • Optional SortDir1: string
    • Optional SortDir10: string
    • Optional SortDir2: string
    • Optional SortDir3: string
    • Optional SortDir4: string
    • Optional SortDir5: string
    • Optional SortDir6: string
    • Optional SortDir7: string
    • Optional SortDir8: string
    • Optional SortDir9: string
    • Optional SortField: string
    • Optional SortField1: string
    • Optional SortField10: string
    • Optional SortField2: string
    • Optional SortField3: string
    • Optional SortField4: string
    • Optional SortField5: string
    • Optional SortField6: string
    • Optional SortField7: string
    • Optional SortField8: string
    • Optional SortField9: string
    • Optional SortFields: string
    • Optional SortFieldValues: string
    • Optional View: string
    • Optional ViewCount: string
    • Optional ViewId: string
    • Optional ViewPath: string
    • Optional WebPartId: string

    Returns IBaseExecution<any>

renderListFilterData

  • renderListFilterData(ExcludeFieldFilteringHtml?: boolean, FieldInternalName?: string, OverrideScope?: string, ProcessQStringToCAML?: string, ViewId?: string): IBaseExecution<any>
  • Parameters

    • Optional ExcludeFieldFilteringHtml: boolean
    • Optional FieldInternalName: string
    • Optional OverrideScope: string
    • Optional ProcessQStringToCAML: string
    • Optional ViewId: string

    Returns IBaseExecution<any>

renderListFormData

  • renderListFormData(itemId?: number, formId?: string, mode?: number): IBaseExecution<string>

reserveListItemId

  • reserveListItemId(): IBaseExecution<number>

resetRoleInheritance

  • resetRoleInheritance(): IBaseExecution<any>

saveAsNewView

  • saveAsNewView(oldName?: string, newName?: string, privateView?: boolean, uri?: string): IBaseExecution<string>
  • Parameters

    • Optional oldName: string
    • Optional newName: string
    • Optional privateView: boolean
    • Optional uri: string

    Returns IBaseExecution<string>

saveAsTemplate

  • saveAsTemplate(strFileName?: string, strName?: string, strDescription?: string, bSaveData?: boolean): IBaseExecution<any>
  • Parameters

    • Optional strFileName: string
    • Optional strName: string
    • Optional strDescription: string
    • Optional bSaveData: boolean

    Returns IBaseExecution<any>

setExemptFromBlockDownloadOfNonViewableFiles

  • setExemptFromBlockDownloadOfNonViewableFiles(value?: boolean): IBaseExecution<any>

stringify

  • stringify(): string

syncFlowCallbackUrl

syncFlowInstance

syncFlowInstances

syncFlowTemplates

unpublishMappedView

update

  • update(properties?: any): IBaseExecution<any>
  • Parameters

    • Optional properties: any

    Returns IBaseExecution<any>

validateAppName

Generated using TypeDoc