Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IListItem<Result>

IListItem

Type parameters

  • Result

Hierarchy

Index

Properties

Optional query

query: (query: IODataQuery) => IBaseExecution<IListItemQuery>

Queries the collection.

param

The OData information.

Type declaration

Methods

AttachmentFiles

ContentType

FieldValuesAsHtml

FieldValuesAsText

FieldValuesForEdit

File

FirstUniqueAncestorSecurableObject

Folder

GetDlpPolicyTip

LikedByInformation

  • LikedByInformation(): IBaseQuery<likedByInformation, likedByInformationOData> & likedByInformationCollections
  • Returns IBaseQuery<likedByInformation, likedByInformationOData> & likedByInformationCollections

ParentList

Properties

RoleAssignments

Versions

batch

  • batch(resolve: (value?: Result) => void): ListItem
  • batch(appendFl?: boolean): ListItem
  • batch(resolve: (value?: Result) => void, appendFl?: boolean): ListItem
  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • resolve: (value?: Result) => void

      The method to be executed after the request completes.

        • (value?: Result): void
        • Parameters

          • Optional value: Result

          Returns void

    Returns ListItem

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • Optional appendFl: boolean

      Flag to execute the request as part of a change set.

    Returns ListItem

  • Method to execute the request as a batch. Currently available in SharePoint Online only.

    Parameters

    • resolve: (value?: Result) => void

      The method to be executed after the request completes.

        • (value?: Result): void
        • Parameters

          • Optional value: Result

          Returns void

    • Optional appendFl: boolean

      Flag to execute the request as part of a change set.

    Returns ListItem

breakRoleInheritance

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

    • Optional copyRoleAssignments: boolean
    • Optional clearSubscopes: boolean

    Returns IBaseExecution<any>

delete

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

deleteWithParameters

  • deleteWithParameters(parameters?: ListItemDeleteParameters): IBaseExecution<any>
  • Parameters

    • Optional parameters: ListItemDeleteParameters

    Returns IBaseExecution<any>

done

  • done<T>(resolve: (value?: T) => void): any
  • Method to wait for the requests to complete.

    Type parameters

    • T

    Parameters

    • resolve: (value?: T) => void

      The method to be executed after the request completes.

        • (value?: T): void
        • Parameters

          • Optional value: T

          Returns void

    Returns any

execute

  • execute(waitFl: boolean): ListItem
  • execute(resolve?: (value?: Result) => void, waitFl?: boolean): ListItem
  • execute(resolve?: (value?: Result) => void, reject?: (value?: Result) => void, waitFl?: boolean): ListItem
  • Method to execute the request.

    Parameters

    • waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns ListItem

  • Method to execute the request.

    Parameters

    • Optional resolve: (value?: Result) => void

      The method to be executed if the request is successful.

        • (value?: Result): void
        • Parameters

          • Optional value: Result

          Returns void

    • Optional waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns ListItem

  • Method to execute the request.

    Parameters

    • Optional resolve: (value?: Result) => void

      The method to be executed if the request is successful.

        • (value?: Result): void
        • Parameters

          • Optional value: Result

          Returns void

    • Optional reject: (value?: Result) => void

      The method to be executed if the request fails.

        • (value?: Result): void
        • Parameters

          • Optional value: Result

          Returns void

    • Optional waitFl: boolean

      Flag to execute the request, after the previous requests have completed.

    Returns ListItem

executeAndWait

  • executeAndWait(): Result
  • Method to execute the request synchronously.

    Returns Result

executeMethod

  • executeMethod(methodName: string, methodConfig: IMethodInfo, args?: any): any
  • Method to execute the request. (This is an internal method, but can be used for dev purposes.)

    Parameters

    • methodName: string

      The method name to execute.

    • methodConfig: IMethodInfo

      The configuration to pass with the request.

    • Optional args: any

      The optional arguments for the request.

    Returns any

getChanges

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

    • Optional query: ChangeQuery

    Returns IBaseCollection<Change>

getHashtags

  • getHashtags(): IBaseCollection<Hashtag>
  • Returns IBaseCollection<Hashtag>

getInfo

  • getInfo(): IRequestInfo
  • Method to get the request information.

    Returns IRequestInfo

getUserEffectivePermissions

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

getWOPIFrameUrl

  • getWOPIFrameUrl(action?: number): IBaseExecution<string>
  • Parameters

    • Optional action: number

    Returns IBaseExecution<string>

mediaServiceUpdate

  • mediaServiceUpdate(parameters?: MediaServiceUpdateParameters): IBaseExecution<any>
  • Parameters

    • Optional parameters: MediaServiceUpdateParameters

    Returns IBaseExecution<any>

mediaServiceUpdateV2

  • mediaServiceUpdateV2(parameters?: MediaServiceUpdateParameters, eventFiringEnabled?: boolean): IBaseExecution<any>
  • Parameters

    • Optional parameters: MediaServiceUpdateParameters
    • Optional eventFiringEnabled: boolean

    Returns IBaseExecution<any>

overridePolicyTip

  • overridePolicyTip(userAction?: number, justification?: string): IBaseExecution<number>
  • Parameters

    • Optional userAction: number
    • Optional justification: string

    Returns IBaseExecution<number>

parseAndSetFieldValue

  • parseAndSetFieldValue(fieldName?: string, value?: string): IBaseExecution<any>
  • Parameters

    • Optional fieldName: string
    • Optional value: string

    Returns IBaseExecution<any>

recycle

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

recycleWithParameters

  • recycleWithParameters(parameters?: ListItemDeleteParameters): IBaseExecution<any>
  • Parameters

    • Optional parameters: ListItemDeleteParameters

    Returns IBaseExecution<any>

resetRoleInheritance

  • resetRoleInheritance(): IBaseExecution<any>

setCommentsDisabled

  • setCommentsDisabled(value?: boolean): IBaseExecution<any>
  • Parameters

    • Optional value: boolean

    Returns IBaseExecution<any>

setComplianceTag

  • setComplianceTag(complianceTag?: string, isTagPolicyHold?: boolean, isTagPolicyRecord?: boolean, isEventBasedTag?: boolean, isTagSuperLock?: boolean): IBaseExecution<any>
  • Parameters

    • Optional complianceTag: string
    • Optional isTagPolicyHold: boolean
    • Optional isTagPolicyRecord: boolean
    • Optional isEventBasedTag: boolean
    • Optional isTagSuperLock: boolean

    Returns IBaseExecution<any>

setComplianceTagWithExplicitMetasUpdate

  • setComplianceTagWithExplicitMetasUpdate(complianceTag?: string, complianceFlags?: number, complianceTagWrittenTime?: any, userEmailAddress?: string): IBaseExecution<any>
  • Parameters

    • Optional complianceTag: string
    • Optional complianceFlags: number
    • Optional complianceTagWrittenTime: any
    • Optional userEmailAddress: string

    Returns IBaseExecution<any>

setComplianceTagWithHold

  • setComplianceTagWithHold(complianceTag?: string): IBaseExecution<any>

setComplianceTagWithMetaInfo

  • setComplianceTagWithMetaInfo(complianceTag?: string, blockDelete?: boolean, blockEdit?: boolean, complianceTagWrittenTime?: any, userEmailAddress?: string, isTagSuperLock?: boolean): IBaseExecution<any>
  • Parameters

    • Optional complianceTag: string
    • Optional blockDelete: boolean
    • Optional blockEdit: boolean
    • Optional complianceTagWrittenTime: any
    • Optional userEmailAddress: string
    • Optional isTagSuperLock: boolean

    Returns IBaseExecution<any>

setComplianceTagWithNoHold

  • setComplianceTagWithNoHold(complianceTag?: string): IBaseExecution<any>

setComplianceTagWithRecord

  • setComplianceTagWithRecord(complianceTag?: string): IBaseExecution<any>

systemUpdate

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

update

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

    • Optional properties: any

    Returns IBaseExecution<any>

updateEx

  • updateEx(parameters?: ListItemUpdateParameters): IBaseExecution<any>
  • Parameters

    • Optional parameters: ListItemUpdateParameters

    Returns IBaseExecution<any>

updateHashtags

  • updateHashtags(hashtagsToAdd?: Array<Hashtag>, hashtagsToRemove?: Array<Hashtag>): IBaseCollection<Hashtag>
  • Parameters

    • Optional hashtagsToAdd: Array<Hashtag>
    • Optional hashtagsToRemove: Array<Hashtag>

    Returns IBaseCollection<Hashtag>

updateOverwriteVersion

  • updateOverwriteVersion(): IBaseExecution<any>

validateUpdateListItem

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

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

    Returns IBaseCollection<ListItemFormUpdateValue>

Generated using TypeDoc