Interface IList

interface IList {
    _inheritingObservers: boolean;
    _url: string;
    delete: ((this: ISPQueryable<any>, eTag?: string) => Promise<void>);
    firstUniqueAncestorSecurableObject: _SPInstance<any>;
    InternalPromise: symbol;
    InternalReject: symbol;
    InternalResolve: symbol;
    items: IItems;
    moments: {
        auth: ((observers: QueryableAuthObserver[], url: URL, init: RequestInit) => Promise<[url: URL, init: RequestInit]>);
        construct: ((observers: QueryableConstructObserver[], init: QueryableInit, path?: string) => Timeline<any>);
        data: ((observers: QueryableDataObserver<any>[], ...args: any[]) => void);
        parse: ((observers: QueryableParseObserver[], url: URL, response: Response, result: any) => Promise<[url: URL, response: Response, result: any]>);
        post: ((observers: QueryablePostObserver[], url: URL, result: any) => Promise<[url: URL, result: any]>);
        pre: ((observers: QueryablePreObserver[], url: string, init: RequestInit, result: any) => Promise<[url: string, init: RequestInit, result: any]>);
        send: ((observers: QueryableSendObserver[], url: URL, init: RequestInit) => Promise<Promise<Response>>);
    };
    observers: ObserverCollection;
    parentUrl: string;
    roleAssignments: IRoleAssignments;
    get effectiveBasePermissions(): ISPQueryable<any>;
    get emit(): EmitProxyType<T>;
    get eventReceivers(): ISPCollection<any[]>;
    get informationRightsManagementSettings(): ISPQueryable<any>;
    get on(): OnProxyType<T>;
    get query(): URLSearchParams;
    get relatedFields(): ISPQueryable<any>;
    addValidateUpdateItemUsingPath(formValues: IListItemFormUpdateValue[], decodedUrl: string, bNewDocumentUpdate?: boolean, checkInComment?: string, additionalProps?: {
        leafName?: string;
        objectType?: 0 | 1 | 2;
    }): Promise<IListItemFormUpdateValue[]>;
    breakRoleInheritance(copyRoleAssignments?: boolean, clearSubscopes?: boolean): Promise<any>;
    cloneObserversOnChange(): void;
    concat(pathPart: string): this;
    currentUserHasPermissions(permission: PermissionKind): Promise<boolean>;
    error(e?: any): void;
    execute(userInit: RequestInit): Promise<void>;
    expand(...expands: string[]): this;
    getChanges(query: IChangeQuery): Promise<any>;
    getContextInfo(path?: string): Promise<IContextInfo>;
    getCurrentUserEffectivePermissions(): Promise<IBasePermissions>;
    getItemsByCAMLQuery(query: ICamlQuery, ...expands: string[]): Promise<any>;
    getListItemChangesSinceToken(query: IChangeLogItemQuery): Promise<string>;
    getParent<T>(factory: ISPInvokableFactory<any>, path?: string, base?: string): T;
    getParentInfos(): Promise<IListParentInfos>;
    getUserEffectivePermissions(loginName: string): Promise<IBasePermissions>;
    hasPermissions(value: IBasePermissions, perm: PermissionKind): boolean;
    log(message: string, level?: number): void;
    recycle(): Promise<string>;
    renderListData(viewXml: string): Promise<IRenderListData>;
    renderListDataAsStream(parameters: IRenderListDataParameters, overrideParameters?: any, query?: Map<string, string>): Promise<IRenderListDataAsStreamResult>;
    renderListFormData(itemId: number, formId: string, mode: ControlMode): Promise<IListFormData>;
    reserveListItemId(): Promise<number>;
    resetRoleInheritance(): Promise<any>;
    select(...selects: string[]): this;
    start(init?: any): Promise<any>;
    toRequestUrl(): string;
    toUrl(): string;
    update(properties: Partial<IListInfo>, eTag?: string): Promise<IListUpdateResult>;
    userHasPermissions(loginName: string, permission: PermissionKind): Promise<boolean>;
    using(...behaviors: TimelinePipe<any>[]): this;
    <T>(init?: RequestInit): Promise<T>;
}

Hierarchy

  • _List
  • IDeleteableWithETag
  • ISecurableMethods
    • IList
  • IList<T>(init?): Promise<T>

  • Type Parameters

    • T = IListInfo

    Parameters

    • Optionalinit: RequestInit

    Returns Promise<T>

Properties

_inheritingObservers _url delete firstUniqueAncestorSecurableObject InternalPromise InternalReject InternalResolve items moments observers parentUrl roleAssignments

Accessors

effectiveBasePermissions emit eventReceivers informationRightsManagementSettings on query relatedFields

Methods

addValidateUpdateItemUsingPath breakRoleInheritance cloneObserversOnChange concat currentUserHasPermissions error execute expand getChanges getContextInfo getCurrentUserEffectivePermissions getItemsByCAMLQuery getListItemChangesSinceToken getParent getParentInfos getUserEffectivePermissions hasPermissions log recycle renderListData renderListDataAsStream renderListFormData reserveListItemId resetRoleInheritance select start toRequestUrl toUrl update userHasPermissions using

Properties

Protected_inheritingObservers

_inheritingObservers: boolean

Protected_url

_url: string

delete

delete: ((this: ISPQueryable<any>, eTag?: string) => Promise<void>)

ReadonlyfirstUniqueAncestorSecurableObject

firstUniqueAncestorSecurableObject: _SPInstance<any>

ProtectedInternalPromise

InternalPromise: symbol

ProtectedInternalReject

InternalReject: symbol

ProtectedInternalResolve

InternalResolve: symbol

Readonlyitems

items: IItems

Protected Readonlymoments

moments: {
    auth: ((observers: QueryableAuthObserver[], url: URL, init: RequestInit) => Promise<[url: URL, init: RequestInit]>);
    construct: ((observers: QueryableConstructObserver[], init: QueryableInit, path?: string) => Timeline<any>);
    data: ((observers: QueryableDataObserver<any>[], ...args: any[]) => void);
    parse: ((observers: QueryableParseObserver[], url: URL, response: Response, result: any) => Promise<[url: URL, response: Response, result: any]>);
    post: ((observers: QueryablePostObserver[], url: URL, result: any) => Promise<[url: URL, result: any]>);
    pre: ((observers: QueryablePreObserver[], url: string, init: RequestInit, result: any) => Promise<[url: string, init: RequestInit, result: any]>);
    send: ((observers: QueryableSendObserver[], url: URL, init: RequestInit) => Promise<Promise<Response>>);
}

Protectedobservers

observers: ObserverCollection

ProtectedparentUrl

parentUrl: string

ReadonlyroleAssignments

roleAssignments: IRoleAssignments

Accessors

effectiveBasePermissions

  • get effectiveBasePermissions(): ISPQueryable<any>

  • Gets the effective base permissions of this list

    Returns ISPQueryable<any>

Protectedemit

  • get emit(): EmitProxyType<T>

  • Property allowing access to invoke a moment from within this timeline

    Returns EmitProxyType<T>

eventReceivers

  • get eventReceivers(): ISPCollection<any[]>

  • Gets the event receivers attached to this list

    Returns ISPCollection<any[]>

informationRightsManagementSettings

  • get informationRightsManagementSettings(): ISPQueryable<any>

  • Gets the IRM settings for this list

    Returns ISPQueryable<any>

on

  • get on(): OnProxyType<T>

  • Property allowing access to manage observers on moments within this timeline

    Returns OnProxyType<T>

query

  • get query(): URLSearchParams

  • Querystring key, value pairs which will be included in the request

    Returns URLSearchParams

relatedFields

  • get relatedFields(): ISPQueryable<any>

  • Gets the related fields of this list

    Returns ISPQueryable<any>

Methods

addValidateUpdateItemUsingPath

  • addValidateUpdateItemUsingPath(formValues, decodedUrl, bNewDocumentUpdate?, checkInComment?, additionalProps?): Promise<IListItemFormUpdateValue[]>

  • Creates an item using path (in a folder), validates and sets its field values.

    Parameters

    • formValues: IListItemFormUpdateValue[]

      The fields to change and their new values.

    • decodedUrl: string

      Path decoded url; folder's server relative path.

    • OptionalbNewDocumentUpdate: boolean

      true if the list item is a document being updated after upload; otherwise false.

    • OptionalcheckInComment: string

      Optional check in comment.

    • OptionaladditionalProps: {
          leafName?: string;
          objectType?: 0 | 1 | 2;
      }

      Optional set of additional properties LeafName new document file name,

      • OptionalleafName?: string

        If creating a document or folder, the name

      • OptionalobjectType?: 0 | 1 | 2

        0: File, 1: Folder, 2: Web

    Returns Promise<IListItemFormUpdateValue[]>

breakRoleInheritance

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

  • Parameters

    • OptionalcopyRoleAssignments: boolean
    • OptionalclearSubscopes: boolean

    Returns Promise<any>

ProtectedcloneObserversOnChange

  • cloneObserversOnChange(): void

  • By default a timeline references the same observer collection as a parent timeline, if any changes are made to the observers this method first clones them ensuring we maintain a local copy and de-ref the parent

    Returns void

concat

  • concat(pathPart): this

  • Directly concatenates the supplied string to the current url, not normalizing "/" chars

    Parameters

    • pathPart: string

      The string to concatenate to the url

    Returns this

currentUserHasPermissions

  • currentUserHasPermissions(permission): Promise<boolean>

  • Parameters

    • permission: PermissionKind

    Returns Promise<boolean>

Protectederror

  • error(e?): void

  • Shorthand method to emit an error event tied to this timeline

    Parameters

    • Optionale: any

      Optional. Any error object to emit. If none is provided no emit occurs

    Returns void

Protectedexecute

  • execute(userInit): Promise<void>

  • Method orchestrating the emit calls for the moments defined in inheriting classes

    Parameters

    • userInit: RequestInit

    Returns Promise<void>

expand

  • expand(...expands): this

  • Expands fields such as lookups to get additional data

    Parameters

    • Rest...expands: string[]

      The Fields for which to expand the values

    Returns this

getChanges

  • getChanges(query): Promise<any>

  • Returns the collection of changes from the change log that have occurred within the list, based on the specified query.

    Parameters

    • query: IChangeQuery

      A query that is performed against the change log.

    Returns Promise<any>

getContextInfo

  • getContextInfo(path?): Promise<IContextInfo>

  • Gets the context info for the specified path

    Parameters

    • Optionalpath: string

      Optional. Absolute path to a SharePoint resource [Default: this.parentUrl]

    Returns Promise<IContextInfo>

getCurrentUserEffectivePermissions

  • getCurrentUserEffectivePermissions(): Promise<IBasePermissions>

  • Returns Promise<IBasePermissions>

getItemsByCAMLQuery

  • getItemsByCAMLQuery(query, ...expands): Promise<any>

  • Returns the collection of items in the list based on the provided CamlQuery

    Parameters

    • query: ICamlQuery

      A query that is performed against the list

    • Rest...expands: string[]

      An expanded array of n items that contains fields to expand in the CamlQuery

    Returns Promise<any>

getListItemChangesSinceToken

  • getListItemChangesSinceToken(query): Promise<string>

  • See: https://msdn.microsoft.com/en-us/library/office/dn292554.aspx

    Parameters

    • query: IChangeLogItemQuery

      An object that defines the change log item query

    Returns Promise<string>

ProtectedgetParent

  • getParent<T>(factory, path?, base?): T

  • Gets a parent for this instance as specified

    Type Parameters

    • T extends ISPQueryable<any>

    Parameters

    • factory: ISPInvokableFactory<any>

      The contructor for the class to create

    • Optionalpath: string
    • Optionalbase: string

    Returns T

getParentInfos

  • getParentInfos(): Promise<IListParentInfos>

  • Gets the parent information for this item's list and web

    Returns Promise<IListParentInfos>

getUserEffectivePermissions

  • getUserEffectivePermissions(loginName): Promise<IBasePermissions>

  • Parameters

    • loginName: string

    Returns Promise<IBasePermissions>

hasPermissions

  • hasPermissions(value, perm): boolean

  • Parameters

    • value: IBasePermissions
    • perm: PermissionKind

    Returns boolean

log

  • log(message, level?): void

  • Shorthand method to emit a logging event tied to this timeline

    Parameters

    • message: string

      The message to log

    • Optionallevel: number

      The level at which the message applies

    Returns void

recycle

  • recycle(): Promise<string>

  • Moves the list to the Recycle Bin and returns the identifier of the new Recycle Bin item.

    Returns Promise<string>

renderListData

  • renderListData(viewXml): Promise<IRenderListData>

  • Renders list data based on the view xml provided

    Parameters

    • viewXml: string

      A string object representing a view xml

    Returns Promise<IRenderListData>

renderListDataAsStream

  • renderListDataAsStream(parameters, overrideParameters?, query?): Promise<IRenderListDataAsStreamResult>

  • Returns the data for the specified query view

    Parameters

    • parameters: IRenderListDataParameters

      The parameters to be used to render list data as JSON string.

    • OptionaloverrideParameters: any
    • Optionalquery: Map<string, string>

      Allows setting of query parameters

    Returns Promise<IRenderListDataAsStreamResult>

renderListFormData

  • renderListFormData(itemId, formId, mode): Promise<IListFormData>

  • Gets the field values and field schema attributes for a list item.

    Parameters

    • itemId: number

      Item id of the item to render form data for

    • formId: string

      The id of the form

    • mode: ControlMode

      Enum representing the control mode of the form (Display, Edit, New)

    Returns Promise<IListFormData>

reserveListItemId

  • reserveListItemId(): Promise<number>

  • Reserves a list item ID for idempotent list item creation.

    Returns Promise<number>

resetRoleInheritance

  • resetRoleInheritance(): Promise<any>

  • Returns Promise<any>

select

  • select(...selects): this

  • Choose which fields to return

    Parameters

    • Rest...selects: string[]

      One or more fields to return

    Returns this

Protectedstart

  • start(init?): Promise<any>

  • Starts a timeline

    Parameters

    • Optionalinit: any

      A value passed into the execute logic from the initiator of the timeline

    Returns Promise<any>

    The result of this.execute

    Description

    This method first emits "init" to allow for any needed initial conditions then calls execute with any supplied init

toRequestUrl

  • toRequestUrl(): string

  • Gets the full url with query information

    Returns string

toUrl

  • toUrl(): string

  • Gets the current url

    Returns string

update

  • update(properties, eTag?): Promise<IListUpdateResult>

  • Updates this list intance with the supplied properties

    Parameters

    • properties: Partial<IListInfo>

      A plain object hash of values to update for the list

    • OptionaleTag: string

      Value used in the IF-Match header, by default "*"

    Returns Promise<IListUpdateResult>

userHasPermissions

  • userHasPermissions(loginName, permission): Promise<boolean>

  • Parameters

    • loginName: string
    • permission: PermissionKind

    Returns Promise<boolean>

using

  • using(...behaviors): this

  • Apply the supplied behavior(s) to this timeline

    Parameters

    • Rest...behaviors: TimelinePipe<any>[]

      One or more behaviors

    Returns this

    this Timeline

Settings

Member Visibility

On This Page

Properties
Accessors
Methods